From 934b449b0eb87f06038413c46b0f695d3bc8961b Mon Sep 17 00:00:00 2001 From: Austin Zielman Date: Thu, 30 May 2024 21:33:21 +0000 Subject: [PATCH] Version 1.3.3 --- abacusai/__init__.py | 2 +- abacusai/api_class/__init__.py | 1 + abacusai/api_class/ai_agents.py | 6 +- abacusai/api_class/blob_input.py | 42 +- abacusai/api_class/connectors.py | 2 +- abacusai/api_class/dataset.py | 2 + abacusai/api_class/enums.py | 36 + abacusai/api_class/feature_group.py | 111 +- abacusai/api_class/model.py | 2 + abacusai/chat_message.py | 12 +- abacusai/client.py | 90 +- abacusai/deployment_conversation.py | 17 +- abacusai/document_data.py | 10 +- abacusai/feature_group.py | 30 +- abacusai/page_data.py | 10 +- abacusai/project.py | 10 +- abacusai/project_feature_group.py | 16 +- abacusai/public.pem | 6 +- docs/.buildinfo | 2 +- .../autoapi/abacusai/abacus_api/index.rst.txt | 26 +- .../autoapi/abacusai/agent/index.rst.txt | 207 +- .../agent_data_document_info/index.rst.txt | 26 +- .../agent_data_execution_result/index.rst.txt | 63 +- .../abacusai/agent_version/index.rst.txt | 116 +- .../abacusai/ai_building_task/index.rst.txt | 26 +- .../autoapi/abacusai/algorithm/index.rst.txt | 77 +- .../autoapi/abacusai/annotation/index.rst.txt | 26 +- .../abacusai/annotation_config/index.rst.txt | 26 +- .../annotation_document/index.rst.txt | 26 +- .../abacusai/annotation_entry/index.rst.txt | 61 +- .../abacusai/annotations_status/index.rst.txt | 63 +- .../abacusai/api_class/abstract/index.rst.txt | 75 +- .../api_class/ai_agents/index.rst.txt | 171 +- .../abacusai/api_class/ai_chat/index.rst.txt | 89 +- .../api_class/batch_prediction/index.rst.txt | 268 +- .../api_class/blob_input/index.rst.txt | 101 +- .../api_class/connectors/index.rst.txt | 75 +- .../abacusai/api_class/dataset/index.rst.txt | 182 +- .../index.rst.txt | 182 +- .../api_class/deployment/index.rst.txt | 246 +- .../document_retriever/index.rst.txt | 134 +- .../abacusai/api_class/enums/index.rst.txt | 952 +- .../api_class/feature_group/index.rst.txt | 379 +- .../autoapi/abacusai/api_class/index.rst.txt | 3679 ++- .../abacusai/api_class/model/index.rst.txt | 937 +- .../abacusai/api_class/monitor/index.rst.txt | 189 +- .../api_class/monitor_alert/index.rst.txt | 232 +- .../abacusai/api_class/project/index.rst.txt | 173 +- .../api_class/python_functions/index.rst.txt | 102 +- .../abacusai/api_class/refresh/index.rst.txt | 145 +- .../abacusai/api_client_utils/index.rst.txt | 82 +- .../abacusai/api_endpoint/index.rst.txt | 26 +- .../autoapi/abacusai/api_key/index.rst.txt | 27 +- .../abacusai/app_user_group/index.rst.txt | 63 +- .../application_connector/index.rst.txt | 30 +- .../abacusai/batch_prediction/index.rst.txt | 387 +- .../batch_prediction_version/index.rst.txt | 260 +- .../index.rst.txt | 26 +- .../categorical_range_violation/index.rst.txt | 26 +- .../abacusai/chat_message/index.rst.txt | 28 +- .../abacusai/chat_session/index.rst.txt | 104 +- .../autoapi/abacusai/client/index.rst.txt | 13783 +--------- .../abacusai/code_source/index.rst.txt | 27 +- .../concatenation_config/index.rst.txt | 26 +- .../cpu_gpu_memory_specs/index.rst.txt | 26 +- .../abacusai/cryptography/index.rst.txt | 12 +- .../custom_loss_function/index.rst.txt | 77 +- .../abacusai/custom_metric/index.rst.txt | 84 +- .../custom_metric_version/index.rst.txt | 79 +- .../custom_train_function_info/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/data_metrics/index.rst.txt | 26 +- .../abacusai/data_prep_logs/index.rst.txt | 26 +- .../data_quality_results/index.rst.txt | 26 +- .../abacusai/data_upload_result/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/database_connector/index.rst.txt | 32 +- .../database_connector_column/index.rst.txt | 26 +- .../database_connector_schema/index.rst.txt | 57 +- .../autoapi/abacusai/dataset/index.rst.txt | 450 +- .../abacusai/dataset_column/index.rst.txt | 26 +- .../abacusai/dataset_version/index.rst.txt | 33 +- .../dataset_version_logs/index.rst.txt | 26 +- .../autoapi/abacusai/deployment/index.rst.txt | 231 +- .../deployment_auth_token/index.rst.txt | 26 +- .../deployment_conversation/index.rst.txt | 117 +- .../index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/document_data/index.rst.txt | 28 +- .../abacusai/document_retriever/index.rst.txt | 238 +- .../document_retriever_config/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../document_retriever_version/index.rst.txt | 70 +- .../abacusai/drift_distribution/index.rst.txt | 67 +- .../drift_distributions/index.rst.txt | 61 +- .../autoapi/abacusai/eda/index.rst.txt | 222 +- .../eda_chart_description/index.rst.txt | 26 +- .../abacusai/eda_collinearity/index.rst.txt | 26 +- .../eda_data_consistency/index.rst.txt | 59 +- .../eda_feature_association/index.rst.txt | 26 +- .../eda_feature_collinearity/index.rst.txt | 26 +- .../eda_forecasting_analysis/index.rst.txt | 69 +- .../abacusai/eda_version/index.rst.txt | 36 +- .../index.rst.txt | 26 +- .../index.rst.txt | 32 +- .../external_application/index.rst.txt | 30 +- .../abacusai/external_invite/index.rst.txt | 26 +- .../abacusai/extracted_fields/index.rst.txt | 26 +- .../autoapi/abacusai/feature/index.rst.txt | 114 +- .../feature_distribution/index.rst.txt | 26 +- .../feature_drift_record/index.rst.txt | 26 +- .../feature_drift_summary/index.rst.txt | 135 +- .../abacusai/feature_group/index.rst.txt | 884 +- .../feature_group_document/index.rst.txt | 26 +- .../feature_group_export/index.rst.txt | 64 +- .../feature_group_export_config/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../feature_group_lineage/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/feature_group_row/index.rst.txt | 26 +- .../feature_group_row_process/index.rst.txt | 28 +- .../index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../feature_group_template/index.rst.txt | 31 +- .../index.rst.txt | 26 +- .../feature_group_version/index.rst.txt | 265 +- .../feature_group_version_logs/index.rst.txt | 26 +- .../abacusai/feature_importance/index.rst.txt | 26 +- .../abacusai/feature_mapping/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/feature_record/index.rst.txt | 26 +- .../abacusai/file_connector/index.rst.txt | 26 +- .../file_connector_instructions/index.rst.txt | 26 +- .../file_connector_verification/index.rst.txt | 26 +- .../finetuned_pretrained_model/index.rst.txt | 26 +- .../index.rst.txt | 106 +- .../index.rst.txt | 69 +- .../forecasting_monitor_summary/index.rst.txt | 112 +- .../abacusai/function_logs/index.rst.txt | 59 +- .../index.rst.txt | 26 +- .../abacusai/global_context/index.rst.txt | 32 +- .../abacusai/graph_dashboard/index.rst.txt | 30 +- .../abacusai/holdout_analysis/index.rst.txt | 30 +- .../holdout_analysis_version/index.rst.txt | 30 +- .../abacusai/hosted_model_token/index.rst.txt | 26 +- docs/_sources/autoapi/abacusai/index.rst.txt | 4380 ++-- .../abacusai/indexing_config/index.rst.txt | 26 +- .../index.rst.txt | 57 +- .../inferred_feature_mappings/index.rst.txt | 57 +- .../abacusai/item_statistics/index.rst.txt | 26 +- .../autoapi/abacusai/llm_app/index.rst.txt | 26 +- .../abacusai/llm_code_block/index.rst.txt | 26 +- .../llm_execution_preview/index.rst.txt | 26 +- .../llm_execution_result/index.rst.txt | 156 +- .../abacusai/llm_generated_code/index.rst.txt | 26 +- .../autoapi/abacusai/llm_input/index.rst.txt | 26 +- .../abacusai/llm_parameters/index.rst.txt | 26 +- .../abacusai/llm_response/index.rst.txt | 63 +- .../abacusai/memory_options/index.rst.txt | 57 +- .../index.rst.txt | 26 +- .../autoapi/abacusai/model/index.rst.txt | 613 +- .../model_artifacts_export/index.rst.txt | 30 +- .../model_blueprint_export/index.rst.txt | 63 +- .../model_blueprint_stage/index.rst.txt | 26 +- .../abacusai/model_location/index.rst.txt | 26 +- .../abacusai/model_metrics/index.rst.txt | 26 +- .../abacusai/model_monitor/index.rst.txt | 253 +- .../model_monitor_org_summary/index.rst.txt | 26 +- .../model_monitor_summary/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../model_monitor_version/index.rst.txt | 36 +- .../index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/model_upload/index.rst.txt | 26 +- .../abacusai/model_version/index.rst.txt | 186 +- .../index.rst.txt | 71 +- .../modification_lock_info/index.rst.txt | 26 +- .../autoapi/abacusai/module/index.rst.txt | 77 +- .../abacusai/monitor_alert/index.rst.txt | 171 +- .../monitor_alert_version/index.rst.txt | 30 +- .../index.rst.txt | 126 +- .../index.rst.txt | 26 +- .../abacusai/nested_feature/index.rst.txt | 26 +- .../nested_feature_schema/index.rst.txt | 57 +- .../abacusai/null_violation/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/organization_group/index.rst.txt | 34 +- .../organization_search_result/index.rst.txt | 1538 +- .../organization_secret/index.rst.txt | 26 +- .../autoapi/abacusai/page_data/index.rst.txt | 30 +- .../autoapi/abacusai/pipeline/index.rst.txt | 428 +- .../abacusai/pipeline_reference/index.rst.txt | 26 +- .../abacusai/pipeline_step/index.rst.txt | 160 +- .../pipeline_step_version/index.rst.txt | 131 +- .../pipeline_step_version_logs/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/pipeline_version/index.rst.txt | 222 +- .../pipeline_version_logs/index.rst.txt | 61 +- .../point_in_time_feature/index.rst.txt | 26 +- .../point_in_time_feature_info/index.rst.txt | 26 +- .../point_in_time_group/index.rst.txt | 61 +- .../point_in_time_group_feature/index.rst.txt | 26 +- .../abacusai/prediction_client/index.rst.txt | 202 +- .../abacusai/prediction_dataset/index.rst.txt | 26 +- .../prediction_feature_group/index.rst.txt | 26 +- .../abacusai/prediction_input/index.rst.txt | 100 +- .../prediction_operator/index.rst.txt | 181 +- .../prediction_operator_version/index.rst.txt | 78 +- .../abacusai/problem_type/index.rst.txt | 26 +- .../autoapi/abacusai/project/index.rst.txt | 310 +- .../abacusai/project_config/index.rst.txt | 44 +- .../project_feature_group/index.rst.txt | 2039 +- .../index.rst.txt | 102 +- .../index.rst.txt | 26 +- .../abacusai/project_validation/index.rst.txt | 26 +- .../abacusai/python_function/index.rst.txt | 79 +- .../python_function_validator/index.rst.txt | 18 +- .../python_plot_function/index.rst.txt | 77 +- .../abacusai/range_violation/index.rst.txt | 26 +- .../abacusai/realtime_monitor/index.rst.txt | 30 +- .../refresh_pipeline_run/index.rst.txt | 178 +- .../abacusai/refresh_policy/index.rst.txt | 97 +- .../abacusai/refresh_schedule/index.rst.txt | 26 +- .../index.rst.txt | 26 +- .../abacusai/return_class/index.rst.txt | 15 +- .../autoapi/abacusai/schema/index.rst.txt | 98 +- .../streaming_auth_token/index.rst.txt | 26 +- .../abacusai/streaming_client/index.rst.txt | 84 +- .../streaming_connector/index.rst.txt | 29 +- .../streaming_row_count/index.rst.txt | 26 +- .../streaming_sample_code/index.rst.txt | 26 +- .../test_point_predictions/index.rst.txt | 26 +- .../training_config_options/index.rst.txt | 26 +- .../autoapi/abacusai/upload/index.rst.txt | 35 +- .../abacusai/upload_part/index.rst.txt | 26 +- .../autoapi/abacusai/use_case/index.rst.txt | 26 +- .../use_case_requirements/index.rst.txt | 26 +- .../autoapi/abacusai/user/index.rst.txt | 140 +- .../abacusai/user_exception/index.rst.txt | 26 +- .../web_search_response/index.rst.txt | 61 +- .../abacusai/web_search_result/index.rst.txt | 26 +- .../autoapi/abacusai/webhook/index.rst.txt | 30 +- docs/_static/searchtools.js | 2 +- docs/autoapi/abacusai/abacus_api/index.html | 448 +- docs/autoapi/abacusai/agent/index.html | 657 +- .../agent_data_document_info/index.html | 448 +- .../agent_data_execution_result/index.html | 490 +- .../autoapi/abacusai/agent_version/index.html | 550 +- .../abacusai/ai_building_task/index.html | 448 +- docs/autoapi/abacusai/algorithm/index.html | 500 +- docs/autoapi/abacusai/annotation/index.html | 448 +- .../abacusai/annotation_config/index.html | 448 +- .../abacusai/annotation_document/index.html | 448 +- .../abacusai/annotation_entry/index.html | 489 +- .../abacusai/annotations_status/index.html | 490 +- .../abacusai/api_class/abstract/index.html | 84 +- .../abacusai/api_class/ai_agents/index.html | 184 +- .../abacusai/api_class/ai_chat/index.html | 148 +- .../api_class/batch_prediction/index.html | 185 +- .../abacusai/api_class/blob_input/index.html | 201 +- .../abacusai/api_class/connectors/index.html | 86 +- .../abacusai/api_class/dataset/index.html | 201 +- .../dataset_application_connector/index.html | 86 +- .../abacusai/api_class/deployment/index.html | 185 +- .../api_class/document_retriever/index.html | 193 +- .../abacusai/api_class/enums/index.html | 156 +- .../api_class/feature_group/index.html | 429 +- docs/autoapi/abacusai/api_class/index.html | 1800 +- .../abacusai/api_class/model/index.html | 201 +- .../abacusai/api_class/monitor/index.html | 174 +- .../api_class/monitor_alert/index.html | 185 +- .../abacusai/api_class/project/index.html | 185 +- .../api_class/python_functions/index.html | 150 +- .../abacusai/api_class/refresh/index.html | 185 +- .../abacusai/api_client_utils/index.html | 449 +- docs/autoapi/abacusai/api_endpoint/index.html | 448 +- docs/autoapi/abacusai/api_key/index.html | 448 +- .../abacusai/app_user_group/index.html | 490 +- .../abacusai/application_connector/index.html | 448 +- .../abacusai/batch_prediction/index.html | 840 +- .../batch_prediction_version/index.html | 695 +- .../batch_prediction_version_logs/index.html | 448 +- .../categorical_range_violation/index.html | 448 +- docs/autoapi/abacusai/chat_message/index.html | 451 +- docs/autoapi/abacusai/chat_session/index.html | 536 +- docs/autoapi/abacusai/client/index.html | 16620 +----------- docs/autoapi/abacusai/code_source/index.html | 448 +- .../abacusai/concatenation_config/index.html | 448 +- .../abacusai/cpu_gpu_memory_specs/index.html | 448 +- docs/autoapi/abacusai/cryptography/index.html | 427 +- .../abacusai/custom_loss_function/index.html | 500 +- .../autoapi/abacusai/custom_metric/index.html | 521 +- .../abacusai/custom_metric_version/index.html | 500 +- .../custom_train_function_info/index.html | 448 +- .../data_consistency_duplication/index.html | 448 +- docs/autoapi/abacusai/data_metrics/index.html | 448 +- .../abacusai/data_prep_logs/index.html | 448 +- .../abacusai/data_quality_results/index.html | 448 +- .../abacusai/data_upload_result/index.html | 448 +- .../index.html | 448 +- .../abacusai/database_connector/index.html | 450 +- .../database_connector_column/index.html | 448 +- .../database_connector_schema/index.html | 487 +- docs/autoapi/abacusai/dataset/index.html | 927 +- .../abacusai/dataset_column/index.html | 448 +- .../abacusai/dataset_version/index.html | 452 +- .../abacusai/dataset_version_logs/index.html | 448 +- docs/autoapi/abacusai/deployment/index.html | 679 +- .../abacusai/deployment_auth_token/index.html | 448 +- .../deployment_conversation/index.html | 519 +- .../deployment_conversation_event/index.html | 448 +- .../deployment_conversation_export/index.html | 448 +- .../autoapi/abacusai/document_data/index.html | 451 +- .../abacusai/document_retriever/index.html | 695 +- .../document_retriever_config/index.html | 448 +- .../index.html | 448 +- .../document_retriever_version/index.html | 490 +- .../abacusai/drift_distribution/index.html | 492 +- .../abacusai/drift_distributions/index.html | 493 +- docs/autoapi/abacusai/eda/index.html | 696 +- .../abacusai/eda_chart_description/index.html | 448 +- .../abacusai/eda_collinearity/index.html | 448 +- .../abacusai/eda_data_consistency/index.html | 492 +- .../eda_feature_association/index.html | 448 +- .../eda_feature_collinearity/index.html | 448 +- .../eda_forecasting_analysis/index.html | 527 +- docs/autoapi/abacusai/eda_version/index.html | 458 +- .../index.html | 448 +- .../index.html | 450 +- .../abacusai/external_application/index.html | 448 +- .../abacusai/external_invite/index.html | 448 +- .../abacusai/extracted_fields/index.html | 448 +- docs/autoapi/abacusai/feature/index.html | 543 +- .../abacusai/feature_distribution/index.html | 448 +- .../abacusai/feature_drift_record/index.html | 448 +- .../abacusai/feature_drift_summary/index.html | 577 +- .../autoapi/abacusai/feature_group/index.html | 1406 +- .../feature_group_document/index.html | 448 +- .../abacusai/feature_group_export/index.html | 489 +- .../feature_group_export_config/index.html | 448 +- .../index.html | 448 +- .../abacusai/feature_group_lineage/index.html | 448 +- .../index.html | 448 +- .../abacusai/feature_group_row/index.html | 448 +- .../feature_group_row_process/index.html | 448 +- .../feature_group_row_process_logs/index.html | 448 +- .../index.html | 448 +- .../feature_group_template/index.html | 450 +- .../index.html | 448 +- .../abacusai/feature_group_version/index.html | 703 +- .../feature_group_version_logs/index.html | 448 +- .../abacusai/feature_importance/index.html | 448 +- .../abacusai/feature_mapping/index.html | 448 +- .../feature_performance_analysis/index.html | 448 +- .../abacusai/feature_record/index.html | 448 +- .../abacusai/file_connector/index.html | 448 +- .../file_connector_instructions/index.html | 448 +- .../file_connector_verification/index.html | 448 +- .../finetuned_pretrained_model/index.html | 448 +- .../index.html | 539 +- .../index.html | 495 +- .../forecasting_monitor_summary/index.html | 554 +- .../autoapi/abacusai/function_logs/index.html | 488 +- .../index.html | 448 +- .../abacusai/global_context/index.html | 442 +- .../abacusai/graph_dashboard/index.html | 448 +- .../abacusai/holdout_analysis/index.html | 452 +- .../holdout_analysis_version/index.html | 448 +- .../abacusai/hosted_model_token/index.html | 448 +- docs/autoapi/abacusai/index.html | 4551 ++-- .../abacusai/indexing_config/index.html | 448 +- .../index.html | 487 +- .../inferred_feature_mappings/index.html | 487 +- .../abacusai/item_statistics/index.html | 448 +- docs/autoapi/abacusai/llm_app/index.html | 448 +- .../abacusai/llm_code_block/index.html | 448 +- .../abacusai/llm_execution_preview/index.html | 448 +- .../abacusai/llm_execution_result/index.html | 624 +- .../abacusai/llm_generated_code/index.html | 448 +- docs/autoapi/abacusai/llm_input/index.html | 448 +- .../abacusai/llm_parameters/index.html | 448 +- docs/autoapi/abacusai/llm_response/index.html | 490 +- .../abacusai/memory_options/index.html | 489 +- .../messaging_connector_response/index.html | 448 +- docs/autoapi/abacusai/model/index.html | 1143 +- .../model_artifacts_export/index.html | 448 +- .../model_blueprint_export/index.html | 490 +- .../abacusai/model_blueprint_stage/index.html | 448 +- .../abacusai/model_location/index.html | 448 +- .../autoapi/abacusai/model_metrics/index.html | 448 +- .../autoapi/abacusai/model_monitor/index.html | 714 +- .../model_monitor_org_summary/index.html | 448 +- .../abacusai/model_monitor_summary/index.html | 448 +- .../model_monitor_summary_from_org/index.html | 448 +- .../abacusai/model_monitor_version/index.html | 456 +- .../index.html | 448 +- .../index.html | 448 +- docs/autoapi/abacusai/model_upload/index.html | 448 +- .../autoapi/abacusai/model_version/index.html | 628 +- .../index.html | 494 +- .../modification_lock_info/index.html | 448 +- docs/autoapi/abacusai/module/index.html | 500 +- .../autoapi/abacusai/monitor_alert/index.html | 604 +- .../abacusai/monitor_alert_version/index.html | 448 +- .../index.html | 549 +- .../natural_language_explanation/index.html | 448 +- .../abacusai/nested_feature/index.html | 448 +- .../abacusai/nested_feature_schema/index.html | 487 +- .../abacusai/null_violation/index.html | 448 +- .../index.html | 448 +- .../abacusai/organization_group/index.html | 448 +- .../organization_search_result/index.html | 2292 +- .../abacusai/organization_secret/index.html | 448 +- docs/autoapi/abacusai/page_data/index.html | 453 +- docs/autoapi/abacusai/pipeline/index.html | 901 +- .../abacusai/pipeline_reference/index.html | 448 +- .../autoapi/abacusai/pipeline_step/index.html | 595 +- .../abacusai/pipeline_step_version/index.html | 555 +- .../pipeline_step_version_logs/index.html | 448 +- .../index.html | 448 +- .../abacusai/pipeline_version/index.html | 656 +- .../abacusai/pipeline_version_logs/index.html | 489 +- .../abacusai/point_in_time_feature/index.html | 448 +- .../point_in_time_feature_info/index.html | 448 +- .../abacusai/point_in_time_group/index.html | 489 +- .../point_in_time_group_feature/index.html | 448 +- .../abacusai/prediction_client/index.html | 688 +- .../abacusai/prediction_dataset/index.html | 448 +- .../prediction_feature_group/index.html | 448 +- .../abacusai/prediction_input/index.html | 536 +- .../abacusai/prediction_operator/index.html | 612 +- .../prediction_operator_version/index.html | 500 +- docs/autoapi/abacusai/problem_type/index.html | 448 +- docs/autoapi/abacusai/project/index.html | 805 +- .../abacusai/project_config/index.html | 468 +- .../abacusai/project_feature_group/index.html | 2868 +-- .../project_feature_group_schema/index.html | 539 +- .../index.html | 448 +- .../abacusai/project_validation/index.html | 448 +- .../abacusai/python_function/index.html | 502 +- .../python_function_validator/index.html | 430 +- .../abacusai/python_plot_function/index.html | 500 +- .../abacusai/range_violation/index.html | 448 +- .../abacusai/realtime_monitor/index.html | 448 +- .../abacusai/refresh_pipeline_run/index.html | 616 +- .../abacusai/refresh_policy/index.html | 520 +- .../abacusai/refresh_schedule/index.html | 448 +- .../index.html | 448 +- docs/autoapi/abacusai/return_class/index.html | 427 +- docs/autoapi/abacusai/schema/index.html | 535 +- .../abacusai/streaming_auth_token/index.html | 448 +- .../abacusai/streaming_client/index.html | 602 +- .../abacusai/streaming_connector/index.html | 448 +- .../abacusai/streaming_row_count/index.html | 448 +- .../abacusai/streaming_sample_code/index.html | 448 +- .../test_point_predictions/index.html | 448 +- .../training_config_options/index.html | 448 +- docs/autoapi/abacusai/upload/index.html | 452 +- docs/autoapi/abacusai/upload_part/index.html | 448 +- docs/autoapi/abacusai/use_case/index.html | 448 +- .../abacusai/use_case_requirements/index.html | 448 +- docs/autoapi/abacusai/user/index.html | 588 +- .../abacusai/user_exception/index.html | 448 +- .../abacusai/web_search_response/index.html | 489 +- .../abacusai/web_search_result/index.html | 448 +- docs/autoapi/abacusai/webhook/index.html | 448 +- docs/genindex.html | 21226 ++++++---------- docs/index.html | 4 +- docs/objects.inv | Bin 70387 -> 54792 bytes docs/py-modindex.html | 2 +- docs/search.html | 2 +- docs/searchindex.js | 2 +- setup.py | 2 +- 473 files changed, 63592 insertions(+), 132057 deletions(-) diff --git a/abacusai/__init__.py b/abacusai/__init__.py index 6df00f519..789751a2e 100644 --- a/abacusai/__init__.py +++ b/abacusai/__init__.py @@ -4,4 +4,4 @@ from .streaming_client import StreamingClient -__version__ = "1.3.2" +__version__ = "1.3.3" diff --git a/abacusai/api_class/__init__.py b/abacusai/api_class/__init__.py index 0ce260731..241a33c33 100644 --- a/abacusai/api_class/__init__.py +++ b/abacusai/api_class/__init__.py @@ -2,6 +2,7 @@ from .ai_chat import * from .batch_prediction import * from .blob_input import * +from .connectors import * from .dataset import * from .dataset_application_connector import * from .deployment import * diff --git a/abacusai/api_class/ai_agents.py b/abacusai/api_class/ai_agents.py index 83f54334c..d2d8107d8 100644 --- a/abacusai/api_class/ai_agents.py +++ b/abacusai/api_class/ai_agents.py @@ -28,7 +28,7 @@ class WorkflowNodeInputSchema(ApiClass): A react-jsonschema-form conformant schema for workflow node input. Args: - json_schema (dict): The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, File Upload. Not supported - Nested elements, arrays and other complex types. + json_schema (dict): The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, file upload. Not supported - Nested elements, arrays and other complex types. ui_schema (dict): The ui schema for the input conformant to react-jsonschema-form specification. """ json_schema: dict @@ -99,6 +99,8 @@ def to_dict(self): @classmethod def from_dict(cls, mapping: dict): + if any(field not in mapping for field in ['name', 'variable_type']): + raise ValueError('Invalid workflow node input mapping. Must contain keys - name, variable_type') return cls( name=mapping['name'], variable_type=mapping['variable_type'], @@ -179,6 +181,8 @@ def to_dict(self): @classmethod def from_dict(cls, node: dict): + if any(field not in node for field in ['name', 'function_name', 'source_code', 'input_mappings', 'output_mappings']): + raise ValueError('Invalid workflow graph node. Must contain keys - name, function_name, source_code, input_mappings, output_mappings.') return cls( name=node['name'], function_name=node['function_name'], diff --git a/abacusai/api_class/blob_input.py b/abacusai/api_class/blob_input.py index faaa6621d..6579382b2 100644 --- a/abacusai/api_class/blob_input.py +++ b/abacusai/api_class/blob_input.py @@ -5,9 +5,9 @@ @dataclasses.dataclass -class BlobInput(ApiClass): +class Blob(ApiClass): """ - Binary large object input data. + Binary large object data. Args: filename (str): The original filename of the blob. @@ -20,14 +20,44 @@ class BlobInput(ApiClass): mime_type: str size: int + def __init__(self, contents: bytes, mime_type: str = None, filename: str = None, size: int = None): + if contents is None or not isinstance(contents, bytes): + raise ValueError('contents must be a valid bytes object') + if mime_type is None: + try: + if filename: + mime_type = mimetypes.guess_type(filename)[0] + else: + import magic + mime_type = magic.Magic(mime=True).from_buffer(contents) + except Exception: + pass + else: + if not isinstance(mime_type, str): + raise ValueError('mime_type must be a valid string') + + self.filename = filename + self.contents = contents + self.mime_type = mime_type + self.size = size or len(contents) + @classmethod - def from_local_file(cls, file_path: str) -> 'BlobInput': + def from_local_file(cls, file_path: str) -> 'Blob': with open(file_path, 'rb') as f: contents = f.read() return cls.from_contents(contents, filename=file_path) @classmethod - def from_contents(cls, contents: bytes, filename: str = None, mime_type: str = None) -> 'BlobInput': - if not mime_type and filename: - mime_type = mimetypes.guess_type(filename)[0] + def from_contents(cls, contents: bytes, filename: str = None, mime_type: str = None) -> 'Blob': return cls(filename=filename, contents=contents, mime_type=mime_type, size=len(contents)) + + +@dataclasses.dataclass +class BlobInput(Blob): + """ + Binary large object data. + An alias for Blob, used to indicate that this is an input object. + """ + + def __init__(self, filename: str = None, contents: bytes = None, mime_type: str = None, size: int = None): + super().__init__(contents, mime_type, filename, size) diff --git a/abacusai/api_class/connectors.py b/abacusai/api_class/connectors.py index 68a9ff5f5..374bc5e94 100644 --- a/abacusai/api_class/connectors.py +++ b/abacusai/api_class/connectors.py @@ -28,7 +28,7 @@ class KafkaDatasetConfig(StreamingConnectorDatasetConfig): Args: topic (str): The kafka topic to consume """ - topic: str + topic: str = dataclasses.field(default=None) def __post_init__(self): self.streaming_connector_type = enums.StreamingConnectorType.KAFKA diff --git a/abacusai/api_class/dataset.py b/abacusai/api_class/dataset.py index 56af979ba..91c19946e 100644 --- a/abacusai/api_class/dataset.py +++ b/abacusai/api_class/dataset.py @@ -42,6 +42,7 @@ class DocumentProcessingConfig(ApiClass): remove_header_footer (bool): Whether to remove headers and footers. Defaults to False. This option only takes effect when extract_bounding_boxes is True. remove_watermarks (bool): Whether to remove watermarks. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. convert_to_markdown (bool): Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. + return_links (bool): Whether to augment the extracted text with embedded URLs in the PDF. Defaults to False. This option only takes effect when the document is a PDF. """ # NOTE: The defaults should match with clouddb.document_processing_results table defaults extract_bounding_boxes: bool = False @@ -50,6 +51,7 @@ class DocumentProcessingConfig(ApiClass): remove_header_footer: bool = False remove_watermarks: bool = True convert_to_markdown: bool = False + return_links: bool = False @dataclasses.dataclass diff --git a/abacusai/api_class/enums.py b/abacusai/api_class/enums.py index 721b9ada0..76abc7829 100644 --- a/abacusai/api_class/enums.py +++ b/abacusai/api_class/enums.py @@ -128,6 +128,17 @@ class MergeMode(ApiEnum): TIME_WINDOW = 'TIME_WINDOW' +class OperatorType(ApiEnum): + UNPIVOT = 'UNPIVOT' + MARKDOWN = 'MARKDOWN' + CRAWLER = 'CRAWLER' + EXTRACT_DOCUMENT_DATA = 'EXTRACT_DOCUMENT_DATA' + + +class MarkdownOperatorInputType(ApiEnum): + HTML = 'HTML' + + class FillLogic(ApiEnum): # back / future AVERAGE = 'average' @@ -406,6 +417,7 @@ class VectorStoreTextEncoder(ApiEnum): OPENAI = 'OPENAI' SENTENCE_BERT = 'SENTENCE_BERT' E5_SMALL = 'E5_SMALL' + CODE_BERT = 'CODE_BERT' class LLMName(ApiEnum): @@ -517,6 +529,7 @@ class OcrMode(ApiEnum): COMPREHENSIVE = 'COMPREHENSIVE' COMPREHENSIVE_V2 = 'COMPREHENSIVE_V2' COMPREHENSIVE_TABLE_MD = 'COMPREHENSIVE_TABLE_MD' + TESSERACT_FAST = 'TESSERACT_FAST' class StdDevThresholdType(ApiEnum): @@ -535,6 +548,7 @@ class DataType(ApiEnum): LIST = 'list' STRUCT = 'struct' NULL = 'null' + BINARY = 'binary' class AgentInterface(ApiEnum): @@ -545,4 +559,26 @@ class AgentInterface(ApiEnum): class ProjectConfigType(ApiEnum): CONSTRAINTS = 'CONSTRAINTS' + CHAT_FEEDBACK = 'CHAT_FEEDBACK' REVIEW_MODE = 'REVIEW_MODE' + + +class CPUSize(ApiEnum): + SMALL = 'small' + MEDIUM = 'medium' + LARGE = 'large' + + +class MemorySize(ApiEnum): + SMALL = 16 + MEDIUM = 32 + LARGE = 64 + XLARGE = 128 + + @classmethod + def from_value(cls, value): + sorted_members = sorted(cls, key=lambda mem: mem.value) + for member in sorted_members: + if member.value >= value: + return member + return None diff --git a/abacusai/api_class/feature_group.py b/abacusai/api_class/feature_group.py index b7a938751..381ab1300 100644 --- a/abacusai/api_class/feature_group.py +++ b/abacusai/api_class/feature_group.py @@ -3,6 +3,7 @@ from . import enums from .abstract import ApiClass, _ApiClassFactory +from .dataset import DocumentProcessingConfig @dataclasses.dataclass @@ -27,7 +28,6 @@ class NSamplingConfig(SamplingConfig): The number of distinct values of the key columns to include in the sample, or number of rows if key columns not specified. Args: - sampling_method (SamplingMethodType): N_SAMPLING sample_count (int): The number of rows to include in the sample key_columns (List[str]): The feature(s) to use as the key(s) when sampling """ @@ -44,7 +44,6 @@ class PercentSamplingConfig(SamplingConfig): The fraction of distinct values of the feature group to include in the sample. Args: - sampling_method (SamplingMethodType): PERCENT_SAMPLING sample_percent (float): The percentage of the rows to sample key_columns (List[str]): The feature(s) to use as the key(s) when sampling """ @@ -87,7 +86,6 @@ class LastNMergeConfig(MergeConfig): Merge LAST N chunks/versions of an incremental dataset. Args: - merge_mode (MergeMode): LAST_N num_versions (int): The number of versions to merge. num_versions == 0 means merge all versions. include_version_timestamp_column (bool): If set, include a column with the creation timestamp of source FG versions. """ @@ -104,7 +102,6 @@ class TimeWindowMergeConfig(MergeConfig): Merge rows within a given timewindow of the most recent timestamp Args: - merge_mode (MergeMode): TIME_WINDOW feature_name (str): Time based column to index on time_window_size_ms (int): Range of merged rows will be [MAX_TIME - time_window_size_ms, MAX_TIME] include_version_timestamp_column (bool): If set, include a column with the creation timestamp of source FG versions. @@ -125,3 +122,109 @@ class _MergeConfigFactory(_ApiClassFactory): enums.MergeMode.LAST_N: LastNMergeConfig, enums.MergeMode.TIME_WINDOW: TimeWindowMergeConfig, } + + +@dataclasses.dataclass +class OperatorConfig(ApiClass): + """Configuration for a template Feature Group Operation""" + operator_type: enums.OperatorType = dataclasses.field(default=None, repr=False, init=False) + + @classmethod + def _get_builder(cls): + return _OperatorConfigFactory + + def __post_init__(self): + if self.__class__ == OperatorConfig: + raise TypeError('Cannot instantiate abstract OperatorConfig class.') + + +@dataclasses.dataclass +class UnpivotConfig(OperatorConfig): + """ Unpivot Columns in a FeatureGroup. + + Args: + columns (List[str]): Which columns to unpivot. + index_column (str): Name of new column containing the unpivoted column names as its values + value_column (str): Name of new column containing the row values that were unpivoted. + exclude (bool): If True, the unpivoted columns are all the columns EXCEPT the ones in the columns argument. Default is False. + """ + + columns: List[str] = dataclasses.field(default=None) + index_column: str = dataclasses.field(default=None) + value_column: str = dataclasses.field(default=None) + exclude: bool = dataclasses.field(default=None) + + def __post_init__(self): + self.operator_type = enums.OperatorType.UNPIVOT + + +@dataclasses.dataclass +class MarkdownConfig(OperatorConfig): + """ Transform a input column to a markdown column. + + Args: + input_column (str): Name of input column to transform. + output_column (str): Name of output column to store transformed data. + input_column_type (MarkdownOperatorInputType): Type of input column to transform. + """ + input_column: str = dataclasses.field(default=None) + output_column: str = dataclasses.field(default=None) + input_column_type: enums.MarkdownOperatorInputType = dataclasses.field(default=None) + + def __post_init__(self): + self.operator_type = enums.OperatorType.MARKDOWN + + +@dataclasses.dataclass +class CrawlerTransformConfig(OperatorConfig): + """ Transform a input column of urls to html text + + Args: + input_column (str): Name of input column to transform. + output_column (str): Name of output column to store transformed data. + depth_column (str): Increasing depth explores more links, capturing more content + disable_host_restriction (bool): If True, will not restrict crawling to the same host. + honour_website_rules (bool): If True, will respect robots.txt rules. + user_agent (str): If provided, will use this user agent instead of randomly selecting one. + """ + input_column: str = dataclasses.field(default=None) + output_column: str = dataclasses.field(default=None) + depth_column: str = dataclasses.field(default=None) + input_column_type: str = dataclasses.field(default=None, metadata={'deprecated': True}) + crawl_depth: int = dataclasses.field(default=None, metadata={'deprecated': True}) + disable_host_restriction: bool = dataclasses.field(default=None) + honour_website_rules: bool = dataclasses.field(default=None) + user_agent: str = dataclasses.field(default=None) + + def __post_init__(self): + self.operator_type = enums.OperatorType.CRAWLER + + +@dataclasses.dataclass +class ExtractDocumentDataConfig(OperatorConfig): + """ Extracts data from documents. + + Args: + doc_id_column (str): Name of input document ID column. + document_column (str): Name of the input document column which contains the page infos. This column will be transformed to include the document processing config in the output feature group. + document_processing_config (DocumentProcessingConfig): Document processing configuration. + """ + doc_id_column: str = dataclasses.field(default=None) + document_column: str = dataclasses.field(default=None) + document_processing_config: DocumentProcessingConfig = dataclasses.field(default=None) + + def __post_init__(self): + self.operator_type = enums.OperatorType.EXTRACT_DOCUMENT_DATA + + +@dataclasses.dataclass +class _OperatorConfigFactory(_ApiClassFactory): + """A class to select and return the the correct type of Operator Config based on a serialized OperatorConfig instance. """ + config_abstract_class = OperatorConfig + config_class_key = 'operator_type' + config_class_map = { + enums.OperatorType.UNPIVOT: UnpivotConfig, + enums.OperatorType.MARKDOWN: MarkdownConfig, + enums.OperatorType.CRAWLER: CrawlerTransformConfig, + enums.OperatorType.EXTRACT_DOCUMENT_DATA: ExtractDocumentDataConfig, + } diff --git a/abacusai/api_class/model.py b/abacusai/api_class/model.py index 16d4e0ae4..838dcf275 100644 --- a/abacusai/api_class/model.py +++ b/abacusai/api_class/model.py @@ -170,6 +170,7 @@ class RegressionTrainingConfig(TrainingConfig): custom_loss_functions (List[str]): Registered custom losses available for selection. custom_metrics (List[str]): Registered custom metrics available for selection. partial_dependence_analysis (PartialDependenceAnalysis): Specify whether to run partial dependence plots for all features or only some features. + do_masked_language_model_pretraining (bool): Specify whether to run a masked language model unsupervised pretraining step before supervized training in certain supported algorithms which use BERT-like backbones. """ objective: enums.RegressionObjective = dataclasses.field(default=None) sort_objective: enums.RegressionObjective = dataclasses.field(default=None) @@ -213,6 +214,7 @@ class RegressionTrainingConfig(TrainingConfig): dropout_rate: int = dataclasses.field(default=None) pretrained_model_name: str = dataclasses.field(default=None) is_multilingual: bool = dataclasses.field(default=None) + do_masked_language_model_pretraining: bool = dataclasses.field(default=None) # loss function loss_function: enums.RegressionLossFunction = dataclasses.field(default=None) diff --git a/abacusai/chat_message.py b/abacusai/chat_message.py index 5c11ba283..01f61e3e0 100644 --- a/abacusai/chat_message.py +++ b/abacusai/chat_message.py @@ -15,9 +15,10 @@ class ChatMessage(AbstractApiClass): docIds (list[str]): A list of IDs of the uploaded document if the message has hotkeyTitle (str): The title of the hotkey prompt if the message has one tasks (list[str]): The list of spawned tasks, if the message was broken down into smaller sub-tasks. + keywordArguments (dict): A dict of kwargs used to generate the response. """ - def __init__(self, client, role=None, text=None, timestamp=None, isUseful=None, feedback=None, docIds=None, hotkeyTitle=None, tasks=None): + def __init__(self, client, role=None, text=None, timestamp=None, isUseful=None, feedback=None, docIds=None, hotkeyTitle=None, tasks=None, keywordArguments=None): super().__init__(client, None) self.role = role self.text = text @@ -27,11 +28,12 @@ def __init__(self, client, role=None, text=None, timestamp=None, isUseful=None, self.doc_ids = docIds self.hotkey_title = hotkeyTitle self.tasks = tasks + self.keyword_arguments = keywordArguments self.deprecated_keys = {} def __repr__(self): - repr_dict = {f'role': repr(self.role), f'text': repr(self.text), f'timestamp': repr(self.timestamp), f'is_useful': repr( - self.is_useful), f'feedback': repr(self.feedback), f'doc_ids': repr(self.doc_ids), f'hotkey_title': repr(self.hotkey_title), f'tasks': repr(self.tasks)} + repr_dict = {f'role': repr(self.role), f'text': repr(self.text), f'timestamp': repr(self.timestamp), f'is_useful': repr(self.is_useful), f'feedback': repr( + self.feedback), f'doc_ids': repr(self.doc_ids), f'hotkey_title': repr(self.hotkey_title), f'tasks': repr(self.tasks), f'keyword_arguments': repr(self.keyword_arguments)} class_name = "ChatMessage" repr_str = ',\n '.join([f'{key}={value}' for key, value in repr_dict.items( ) if getattr(self, key, None) is not None and key not in self.deprecated_keys]) @@ -44,6 +46,6 @@ def to_dict(self): Returns: dict: The dict value representation of the class parameters """ - resp = {'role': self.role, 'text': self.text, 'timestamp': self.timestamp, 'is_useful': self.is_useful, - 'feedback': self.feedback, 'doc_ids': self.doc_ids, 'hotkey_title': self.hotkey_title, 'tasks': self.tasks} + resp = {'role': self.role, 'text': self.text, 'timestamp': self.timestamp, 'is_useful': self.is_useful, 'feedback': self.feedback, + 'doc_ids': self.doc_ids, 'hotkey_title': self.hotkey_title, 'tasks': self.tasks, 'keyword_arguments': self.keyword_arguments} return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys} diff --git a/abacusai/client.py b/abacusai/client.py index e2b7d951d..058065b1c 100644 --- a/abacusai/client.py +++ b/abacusai/client.py @@ -33,16 +33,19 @@ from .annotations_status import AnnotationsStatus from .api_class import ( AgentInterface, AlertActionConfig, AlertConditionConfig, ApiClass, ApiEnum, - ApplicationConnectorDatasetConfig, BatchPredictionArgs, BlobInput, - DatasetDocumentProcessingConfig, DataType, DocumentProcessingConfig, - EvalArtifactType, FeatureGroupExportConfig, ForecastingMonitorConfig, - IncrementalDatabaseConnectorConfig, LLMName, MergeConfig, ParsingConfig, + ApplicationConnectorDatasetConfig, BatchPredictionArgs, Blob, BlobInput, + CPUSize, DatasetDocumentProcessingConfig, DataType, + DocumentProcessingConfig, EvalArtifactType, FeatureGroupExportConfig, + ForecastingMonitorConfig, IncrementalDatabaseConnectorConfig, LLMName, + MemorySize, MergeConfig, OperatorConfig, ParsingConfig, PredictionArguments, ProblemType, ProjectFeatureGroupConfig, - PythonFunctionType, SamplingConfig, TrainingConfig, VectorStoreConfig, - WorkflowGraph, get_clean_function_source_code + PythonFunctionType, SamplingConfig, StreamingConnectorDatasetConfig, + TrainingConfig, VectorStoreConfig, WorkflowGraph, + get_clean_function_source_code ) from .api_class.abstract import get_clean_function_source_code, snake_case from .api_class.ai_agents import WorkflowGraph +from .api_class.blob_input import Blob, BlobInput from .api_client_utils import ( INVALID_PANDAS_COLUMN_NAME_CHARACTERS, StreamingHandler, StreamType, clean_column_name, get_object_from_context @@ -253,25 +256,6 @@ def _discover_service_url(service_discovery_url, client_version, deployment_id, _cached_endpoints = {} -class Blob: - - def __init__(self, contents: bytes, mime_type: str = None, filename: str = None): - if contents is None or not isinstance(contents, bytes): - raise Exception( - 'Contents are required and should be of bytes type') - self.filename = filename - self.contents = contents - if mime_type is None: - try: - import magic - mime_type = magic.Magic(mime=True).from_buffer(contents) - except Exception: - pass - if mime_type is not None and not isinstance(mime_type, str): - raise Exception('mime_type should be of string type') - self.mime_type = mime_type - - class AgentResponse: """ Response object for agent to support attachments, section data and normal data @@ -608,7 +592,7 @@ class BaseApiClient: client_options (ClientOptions): Optional API client configurations skip_version_check (bool): If true, will skip checking the server's current API version on initializing the client """ - client_version = '1.3.2' + client_version = '1.3.3' def __init__(self, api_key: str = None, server: str = None, client_options: ClientOptions = None, skip_version_check: bool = False): self.api_key = api_key @@ -2527,7 +2511,7 @@ def list_chat_sessions(self, most_recent_per_project: bool = False) -> ChatSessi ChatSession: The chat sessions with Data Science Co-pilot""" return self._call_api('listChatSessions', 'GET', query_params={'mostRecentPerProject': most_recent_per_project}, parse_type=ChatSession) - def get_deployment_conversation(self, deployment_conversation_id: str = None, external_session_id: str = None, deployment_id: str = None, deployment_token: str = None, filter_intermediate_conversation_events: bool = True) -> DeploymentConversation: + def get_deployment_conversation(self, deployment_conversation_id: str = None, external_session_id: str = None, deployment_id: str = None, deployment_token: str = None, filter_intermediate_conversation_events: bool = True, get_unused_document_uploads: bool = False) -> DeploymentConversation: """Gets a deployment conversation. Args: @@ -2536,10 +2520,11 @@ def get_deployment_conversation(self, deployment_conversation_id: str = None, ex deployment_id (str): The deployment this conversation belongs to. This is required if not logged in. deployment_token (str): The deployment token to authenticate access to the deployment. This is required if not logged in. filter_intermediate_conversation_events (bool): If true, intermediate conversation events will be filtered out. Default is true. + get_unused_document_uploads (bool): If true, unused document uploads will be returned. Default is false. Returns: DeploymentConversation: The deployment conversation.""" - return self._proxy_request('getDeploymentConversation', 'GET', query_params={'deploymentConversationId': deployment_conversation_id, 'externalSessionId': external_session_id, 'deploymentId': deployment_id, 'deploymentToken': deployment_token, 'filterIntermediateConversationEvents': filter_intermediate_conversation_events}, parse_type=DeploymentConversation, is_sync=True) + return self._proxy_request('getDeploymentConversation', 'GET', query_params={'deploymentConversationId': deployment_conversation_id, 'externalSessionId': external_session_id, 'deploymentId': deployment_id, 'deploymentToken': deployment_token, 'filterIntermediateConversationEvents': filter_intermediate_conversation_events, 'getUnusedDocumentUploads': get_unused_document_uploads}, parse_type=DeploymentConversation, is_sync=True) def list_deployment_conversations(self, deployment_id: str, external_application_id: str = None) -> List[DeploymentConversation]: """Lists all conversations for the given deployment and current user. @@ -3549,7 +3534,7 @@ def get_agent_context_chat_history(self): execute function. Returns: - List[ChatMessage]:: The chat history for the current request being processed by the Agent. + List[ChatMessage]: The chat history for the current request being processed by the Agent. """ from .chat_message import ChatMessage return get_object_from_context(self, _request_context, 'chat_history', List[ChatMessage]) or [] @@ -3673,7 +3658,7 @@ def streaming_evaluate_prompt(self, prompt: str = None, system_message: str = No section_key (str): Key to identify output schema section. Returns: - text: The response from the model. + text (str): The response from the model. """ caller = self._get_agent_async_app_caller() request_id = self._get_agent_app_request_id() @@ -4444,7 +4429,7 @@ def create_feature_group_from_template(self, table_name: str, feature_group_temp FeatureGroup: The created feature group.""" return self._call_api('createFeatureGroupFromTemplate', 'POST', query_params={}, body={'tableName': table_name, 'featureGroupTemplateId': feature_group_template_id, 'templateBindings': template_bindings, 'shouldAttachFeatureGroupToTemplate': should_attach_feature_group_to_template, 'description': description}, parse_type=FeatureGroup) - def create_feature_group_from_function(self, table_name: str, function_source_code: str = None, function_name: str = None, input_feature_groups: list = None, description: str = None, cpu_size: str = None, memory: int = None, package_requirements: list = None, use_original_csv_names: bool = False, python_function_name: str = None, python_function_bindings: List = None, use_gpu: bool = None) -> FeatureGroup: + def create_feature_group_from_function(self, table_name: str, function_source_code: str = None, function_name: str = None, input_feature_groups: list = None, description: str = None, cpu_size: Union[CPUSize, str] = None, memory: Union[MemorySize, str] = None, package_requirements: list = None, use_original_csv_names: bool = False, python_function_name: str = None, python_function_bindings: List = None, use_gpu: bool = None) -> FeatureGroup: """Creates a new feature in a Feature Group from user-provided code. Currently supported code languages are Python. If a list of input feature groups are supplied, we will provide DataFrames (pandas, in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. @@ -4458,8 +4443,8 @@ def create_feature_group_from_function(self, table_name: str, function_source_co function_name (str): Name of the function found in the source code that will be executed (on the optional inputs) to materialize this feature group. input_feature_groups (list): List of feature group names that are supplied to the function as parameters. Each of the parameters are materialized Dataframes (same type as the functions return value). description (str): The description for this feature group. - cpu_size (str): Size of the CPU for the feature group function. - memory (int): Memory (in GB) for the feature group function. + cpu_size (CPUSize): Size of the CPU for the feature group function. + memory (MemorySize): Memory (in GB) for the feature group function. package_requirements (list): List of package requirements for the feature group function. For example: ['numpy==1.2.3', 'pandas>=1.4.0'] use_original_csv_names (bool): Defaults to False, if set it uses the original column names for input feature groups from CSV datasets. python_function_name (str): Name of Python Function that contains the source code and function arguments. @@ -4501,13 +4486,13 @@ def create_merge_feature_group(self, source_feature_group_id: str, table_name: s Creates a new feature group defined as the union of other feature group versions.""" return self._call_api('createMergeFeatureGroup', 'POST', query_params={}, body={'sourceFeatureGroupId': source_feature_group_id, 'tableName': table_name, 'mergeConfig': merge_config, 'description': description}, parse_type=FeatureGroup) - def create_operator_feature_group(self, source_feature_group_id: str, table_name: str, operator_config: dict, description: str = None) -> FeatureGroup: + def create_operator_feature_group(self, source_feature_group_id: str, table_name: str, operator_config: Union[dict, OperatorConfig], description: str = None) -> FeatureGroup: """Creates a new Feature Group defined by a pre-defined operator applied to another Feature Group. Args: source_feature_group_id (str): Unique string identifier corresponding to the Feature Group to which the operator will be applied. table_name (str): Unique string identifier for the operator Feature Group. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - operator_config (dict): JSON object (aka map) defining the operator and its parameters. + operator_config (OperatorConfig): The operator config is used to define the operator and its parameters. description (str): Human-readable description of the Feature Group. Returns: @@ -4559,13 +4544,16 @@ def set_feature_group_merge_config(self, feature_group_id: str, merge_config: Un FeatureGroup: The updated FeatureGroup.""" return self._call_api('setFeatureGroupMergeConfig', 'POST', query_params={}, body={'featureGroupId': feature_group_id, 'mergeConfig': merge_config}, parse_type=FeatureGroup) - def set_feature_group_operator_config(self, feature_group_id: str, operator_config: dict): + def set_feature_group_operator_config(self, feature_group_id: str, operator_config: Union[dict, OperatorConfig]) -> FeatureGroup: """Set a OperatorFeatureGroup’s operator config to the values provided. Args: feature_group_id (str): A unique string identifier associated with the feature group. - operator_config (dict): A dictionary object specifying the pre-defined operations.""" - return self._call_api('setFeatureGroupOperatorConfig', 'POST', query_params={}, body={'featureGroupId': feature_group_id, 'operatorConfig': operator_config}) + operator_config (OperatorConfig): A dictionary object specifying the pre-defined operations. + + Returns: + FeatureGroup: The updated FeatureGroup.""" + return self._call_api('setFeatureGroupOperatorConfig', 'POST', query_params={}, body={'featureGroupId': feature_group_id, 'operatorConfig': operator_config}, parse_type=FeatureGroup) def set_feature_group_schema(self, feature_group_id: str, schema: list): """Creates a new schema and points the feature group to the new feature group schema ID. @@ -4982,7 +4970,7 @@ def update_feature_group_python_function_bindings(self, feature_group_id: str, p python_function_bindings (List): List of python function arguments.""" return self._call_api('updateFeatureGroupPythonFunctionBindings', 'PATCH', query_params={}, body={'featureGroupId': feature_group_id, 'pythonFunctionBindings': python_function_bindings}) - def update_feature_group_python_function(self, feature_group_id: str, python_function_name: str, python_function_bindings: List = None, cpu_size: str = None, memory: int = None, use_gpu: bool = None, use_original_csv_names: bool = None): + def update_feature_group_python_function(self, feature_group_id: str, python_function_name: str, python_function_bindings: List = None, cpu_size: Union[CPUSize, str] = None, memory: Union[MemorySize, str] = None, use_gpu: bool = None, use_original_csv_names: bool = None): """Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function bindings, we will provide as arguments to the function DataFrame's (pandas in the case of Python) with the materialized @@ -4993,8 +4981,8 @@ def update_feature_group_python_function(self, feature_group_id: str, python_fun feature_group_id (str): The unique ID associated with the feature group. python_function_name (str): The name of the python function to be associated with the feature group. python_function_bindings (List): List of python function arguments. - cpu_size (str): Size of the CPU for the feature group python function. - memory (int): Memory (in GB) for the feature group python function. + cpu_size (CPUSize): Size of the CPU for the feature group python function. + memory (MemorySize): Memory (in GB) for the feature group python function. use_gpu (bool): Whether the feature group needs a gpu or not. Otherwise default to CPU. use_original_csv_names (bool): If enabled, it uses the original column names for input feature groups from CSV datasets.""" return self._call_api('updateFeatureGroupPythonFunction', 'PATCH', query_params={}, body={'featureGroupId': feature_group_id, 'pythonFunctionName': python_function_name, 'pythonFunctionBindings': python_function_bindings, 'cpuSize': cpu_size, 'memory': memory, 'useGpu': use_gpu, 'useOriginalCsvNames': use_original_csv_names}) @@ -5394,18 +5382,18 @@ def set_dataset_column_data_type(self, dataset_id: str, column: str, data_type: Dataset: The dataset and schema after the data type has been set.""" return self._call_api('setDatasetColumnDataType', 'POST', query_params={'datasetId': dataset_id}, body={'column': column, 'dataType': data_type}, parse_type=Dataset) - def create_dataset_from_streaming_connector(self, table_name: str, streaming_connector_id: str, streaming_args: dict = None, refresh_schedule: str = None) -> Dataset: + def create_dataset_from_streaming_connector(self, table_name: str, streaming_connector_id: str, dataset_config: Union[dict, StreamingConnectorDatasetConfig] = None, refresh_schedule: str = None) -> Dataset: """Creates a dataset from a Streaming Connector Args: table_name (str): Organization-unique table name streaming_connector_id (str): Unique String Identifier for the Streaming Connector to import the dataset from - streaming_args (dict): Dictionary of arguments to read data from the streaming connector + dataset_config (StreamingConnectorDatasetConfig): Streaming dataset config refresh_schedule (str): Cron time string format that describes a schedule to retrieve the latest version of the imported dataset. Time is specified in UTC. Returns: Dataset: The created dataset.""" - return self._call_api('createDatasetFromStreamingConnector', 'POST', query_params={}, body={'tableName': table_name, 'streamingConnectorId': streaming_connector_id, 'streamingArgs': streaming_args, 'refreshSchedule': refresh_schedule}, parse_type=Dataset) + return self._call_api('createDatasetFromStreamingConnector', 'POST', query_params={}, body={'tableName': table_name, 'streamingConnectorId': streaming_connector_id, 'datasetConfig': dataset_config, 'refreshSchedule': refresh_schedule}, parse_type=Dataset) def set_streaming_retention_policy(self, dataset_id: str, retention_hours: int = None, retention_row_count: int = None, ignore_records_before_timestamp: int = None): """Sets the streaming retention policy. @@ -5841,7 +5829,7 @@ def export_custom_model_version(self, model_version: str, output_location: str, ModelArtifactsExport: Object describing the export and its status.""" return self._call_api('exportCustomModelVersion', 'POST', query_params={}, body={'modelVersion': model_version, 'outputLocation': output_location, 'algorithm': algorithm}, parse_type=ModelArtifactsExport) - def create_model_monitor(self, project_id: str, prediction_feature_group_id: str, training_feature_group_id: str = None, name: str = None, refresh_schedule: str = None, target_value: str = None, target_value_bias: str = None, target_value_performance: str = None, feature_mappings: dict = None, model_id: str = None, training_feature_mappings: dict = None, feature_group_base_monitor_config: dict = None, feature_group_comparison_monitor_config: dict = None, include_interactive_performance_analysis: bool = False) -> ModelMonitor: + def create_model_monitor(self, project_id: str, prediction_feature_group_id: str, training_feature_group_id: str = None, name: str = None, refresh_schedule: str = None, target_value: str = None, target_value_bias: str = None, target_value_performance: str = None, feature_mappings: dict = None, model_id: str = None, training_feature_mappings: dict = None, feature_group_base_monitor_config: dict = None, feature_group_comparison_monitor_config: dict = None, exclude_interactive_performance_analysis: bool = True, exclude_bias_analysis: bool = None, exclude_performance_analysis: bool = None, exclude_feature_drift_analysis: bool = None, exclude_data_integrity_analysis: bool = None) -> ModelMonitor: """Runs a model monitor for the specified project. Args: @@ -5858,11 +5846,15 @@ def create_model_monitor(self, project_id: str, prediction_feature_group_id: str training_feature_mappings (dict): A JSON map to override features for training_fature_group, where keys are column names and the values are feature data use types. feature_group_base_monitor_config (dict): Selection strategy for the feature_group 1 with the feature group version if selected. feature_group_comparison_monitor_config (dict): Selection strategy for the feature_group 1 with the feature group version if selected. - include_interactive_performance_analysis (bool): Whether to include interactive performance analysis. + exclude_interactive_performance_analysis (bool): Whether to exclude interactive performance analysis. Defaults to True if not provided. + exclude_bias_analysis (bool): Whether to exclude bias analysis in the model monitor. For default value bias analysis is included. + exclude_performance_analysis (bool): Whether to exclude performance analysis in the model monitor. For default value performance analysis is included. + exclude_feature_drift_analysis (bool): Whether to exclude feature drift analysis in the model monitor. For default value feature drift analysis is included. + exclude_data_integrity_analysis (bool): Whether to exclude data integrity analysis in the model monitor. For default value data integrity analysis is included. Returns: ModelMonitor: The new model monitor that was created.""" - return self._call_api('createModelMonitor', 'POST', query_params={}, body={'projectId': project_id, 'predictionFeatureGroupId': prediction_feature_group_id, 'trainingFeatureGroupId': training_feature_group_id, 'name': name, 'refreshSchedule': refresh_schedule, 'targetValue': target_value, 'targetValueBias': target_value_bias, 'targetValuePerformance': target_value_performance, 'featureMappings': feature_mappings, 'modelId': model_id, 'trainingFeatureMappings': training_feature_mappings, 'featureGroupBaseMonitorConfig': feature_group_base_monitor_config, 'featureGroupComparisonMonitorConfig': feature_group_comparison_monitor_config, 'includeInteractivePerformanceAnalysis': include_interactive_performance_analysis}, parse_type=ModelMonitor) + return self._call_api('createModelMonitor', 'POST', query_params={}, body={'projectId': project_id, 'predictionFeatureGroupId': prediction_feature_group_id, 'trainingFeatureGroupId': training_feature_group_id, 'name': name, 'refreshSchedule': refresh_schedule, 'targetValue': target_value, 'targetValueBias': target_value_bias, 'targetValuePerformance': target_value_performance, 'featureMappings': feature_mappings, 'modelId': model_id, 'trainingFeatureMappings': training_feature_mappings, 'featureGroupBaseMonitorConfig': feature_group_base_monitor_config, 'featureGroupComparisonMonitorConfig': feature_group_comparison_monitor_config, 'excludeInteractivePerformanceAnalysis': exclude_interactive_performance_analysis, 'excludeBiasAnalysis': exclude_bias_analysis, 'excludePerformanceAnalysis': exclude_performance_analysis, 'excludeFeatureDriftAnalysis': exclude_feature_drift_analysis, 'excludeDataIntegrityAnalysis': exclude_data_integrity_analysis}, parse_type=ModelMonitor) def rerun_model_monitor(self, model_monitor_id: str) -> ModelMonitor: """Re-runs the specified model monitor. @@ -8155,7 +8147,7 @@ def evaluate_prompt(self, prompt: str = None, system_message: str = None, llm_na LlmResponse: The response from the model, raw text and parsed components.""" return self._proxy_request('EvaluatePrompt', 'POST', query_params={}, body={'prompt': prompt, 'systemMessage': system_message, 'llmName': llm_name, 'maxTokens': max_tokens, 'temperature': temperature, 'messages': messages, 'responseType': response_type, 'jsonResponseSchema': json_response_schema}, parse_type=LlmResponse) - def render_feature_groups_for_llm(self, feature_group_ids: List, token_budget: int = None, include_definition: bool = True) -> LlmInput: + def render_feature_groups_for_llm(self, feature_group_ids: List, token_budget: int = None, include_definition: bool = True) -> List[LlmInput]: """Encode feature groups as language model inputs. Args: @@ -8164,7 +8156,7 @@ def render_feature_groups_for_llm(self, feature_group_ids: List, token_budget: i include_definition (bool): Include the definition of the feature group in the encoding. Returns: - LlmInput: LLM input object comprising of information about the feature groups with given IDs.""" + list[LlmInput]: LLM input object comprising of information about the feature groups with given IDs.""" return self._call_api('renderFeatureGroupsForLLM', 'POST', query_params={}, body={'featureGroupIds': feature_group_ids, 'tokenBudget': token_budget, 'includeDefinition': include_definition}, parse_type=LlmInput) def generate_code_for_data_query_using_llm(self, query: str, feature_group_ids: List = None, external_database_schemas: List = None, prompt_context: str = None, llm_name: Union[LLMName, str] = None, temperature: float = None, sql_dialect: str = 'Spark') -> LlmGeneratedCode: diff --git a/abacusai/deployment_conversation.py b/abacusai/deployment_conversation.py index 786a18242..4674cf3d5 100644 --- a/abacusai/deployment_conversation.py +++ b/abacusai/deployment_conversation.py @@ -16,10 +16,11 @@ class DeploymentConversation(AbstractApiClass): externalSessionId (str): The external session id associated with the deployment conversation. regenerateAttempt (int): The sequence number of regeneration. Not regenerated if 0. externalApplicationId (str): The external application id associated with the deployment conversation. + unusedDocumentUploadIds (list[str]): The list of unused document upload ids associated with the deployment conversation. history (DeploymentConversationEvent): The history of the deployment conversation. """ - def __init__(self, client, deploymentConversationId=None, name=None, deploymentId=None, createdAt=None, lastEventCreatedAt=None, externalSessionId=None, regenerateAttempt=None, externalApplicationId=None, history={}): + def __init__(self, client, deploymentConversationId=None, name=None, deploymentId=None, createdAt=None, lastEventCreatedAt=None, externalSessionId=None, regenerateAttempt=None, externalApplicationId=None, unusedDocumentUploadIds=None, history={}): super().__init__(client, deploymentConversationId) self.deployment_conversation_id = deploymentConversationId self.name = name @@ -29,13 +30,14 @@ def __init__(self, client, deploymentConversationId=None, name=None, deploymentI self.external_session_id = externalSessionId self.regenerate_attempt = regenerateAttempt self.external_application_id = externalApplicationId + self.unused_document_upload_ids = unusedDocumentUploadIds self.history = client._build_class( DeploymentConversationEvent, history) self.deprecated_keys = {} def __repr__(self): - repr_dict = {f'deployment_conversation_id': repr(self.deployment_conversation_id), f'name': repr(self.name), f'deployment_id': repr(self.deployment_id), f'created_at': repr(self.created_at), f'last_event_created_at': repr( - self.last_event_created_at), f'external_session_id': repr(self.external_session_id), f'regenerate_attempt': repr(self.regenerate_attempt), f'external_application_id': repr(self.external_application_id), f'history': repr(self.history)} + repr_dict = {f'deployment_conversation_id': repr(self.deployment_conversation_id), f'name': repr(self.name), f'deployment_id': repr(self.deployment_id), f'created_at': repr(self.created_at), f'last_event_created_at': repr(self.last_event_created_at), f'external_session_id': repr( + self.external_session_id), f'regenerate_attempt': repr(self.regenerate_attempt), f'external_application_id': repr(self.external_application_id), f'unused_document_upload_ids': repr(self.unused_document_upload_ids), f'history': repr(self.history)} class_name = "DeploymentConversation" repr_str = ',\n '.join([f'{key}={value}' for key, value in repr_dict.items( ) if getattr(self, key, None) is not None and key not in self.deprecated_keys]) @@ -48,11 +50,11 @@ def to_dict(self): Returns: dict: The dict value representation of the class parameters """ - resp = {'deployment_conversation_id': self.deployment_conversation_id, 'name': self.name, 'deployment_id': self.deployment_id, 'created_at': self.created_at, 'last_event_created_at': self.last_event_created_at, - 'external_session_id': self.external_session_id, 'regenerate_attempt': self.regenerate_attempt, 'external_application_id': self.external_application_id, 'history': self._get_attribute_as_dict(self.history)} + resp = {'deployment_conversation_id': self.deployment_conversation_id, 'name': self.name, 'deployment_id': self.deployment_id, 'created_at': self.created_at, 'last_event_created_at': self.last_event_created_at, 'external_session_id': self.external_session_id, + 'regenerate_attempt': self.regenerate_attempt, 'external_application_id': self.external_application_id, 'unused_document_upload_ids': self.unused_document_upload_ids, 'history': self._get_attribute_as_dict(self.history)} return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys} - def get(self, external_session_id: str = None, deployment_id: str = None, deployment_token: str = None, filter_intermediate_conversation_events: bool = True): + def get(self, external_session_id: str = None, deployment_id: str = None, deployment_token: str = None, filter_intermediate_conversation_events: bool = True, get_unused_document_uploads: bool = False): """ Gets a deployment conversation. @@ -61,11 +63,12 @@ def get(self, external_session_id: str = None, deployment_id: str = None, deploy deployment_id (str): The deployment this conversation belongs to. This is required if not logged in. deployment_token (str): The deployment token to authenticate access to the deployment. This is required if not logged in. filter_intermediate_conversation_events (bool): If true, intermediate conversation events will be filtered out. Default is true. + get_unused_document_uploads (bool): If true, unused document uploads will be returned. Default is false. Returns: DeploymentConversation: The deployment conversation. """ - return self.client.get_deployment_conversation(self.deployment_conversation_id, external_session_id, deployment_id, deployment_token, filter_intermediate_conversation_events) + return self.client.get_deployment_conversation(self.deployment_conversation_id, external_session_id, deployment_id, deployment_token, filter_intermediate_conversation_events, get_unused_document_uploads) def delete(self, deployment_id: str = None, deployment_token: str = None): """ diff --git a/abacusai/document_data.py b/abacusai/document_data.py index 9b58d9f66..4228b3d14 100644 --- a/abacusai/document_data.py +++ b/abacusai/document_data.py @@ -18,9 +18,10 @@ class DocumentData(AbstractApiClass): metadata (list): List of metadata for each page in the document. pageMarkdown (list): The markdown text for the page. extractedPageText (list): List of extracted text for each page in the document obtained from OCR. + augmentedPageText (list): List of extracted text for each page in the document obtained from OCR augmented with embedded links in the document. """ - def __init__(self, client, docId=None, mimeType=None, pageCount=None, totalPageCount=None, extractedText=None, embeddedText=None, pages=None, tokens=None, metadata=None, pageMarkdown=None, extractedPageText=None): + def __init__(self, client, docId=None, mimeType=None, pageCount=None, totalPageCount=None, extractedText=None, embeddedText=None, pages=None, tokens=None, metadata=None, pageMarkdown=None, extractedPageText=None, augmentedPageText=None): super().__init__(client, None) self.doc_id = docId self.mime_type = mimeType @@ -33,11 +34,12 @@ def __init__(self, client, docId=None, mimeType=None, pageCount=None, totalPageC self.metadata = metadata self.page_markdown = pageMarkdown self.extracted_page_text = extractedPageText + self.augmented_page_text = augmentedPageText self.deprecated_keys = {} def __repr__(self): repr_dict = {f'doc_id': repr(self.doc_id), f'mime_type': repr(self.mime_type), f'page_count': repr(self.page_count), f'total_page_count': repr(self.total_page_count), f'extracted_text': repr(self.extracted_text), f'embedded_text': repr( - self.embedded_text), f'pages': repr(self.pages), f'tokens': repr(self.tokens), f'metadata': repr(self.metadata), f'page_markdown': repr(self.page_markdown), f'extracted_page_text': repr(self.extracted_page_text)} + self.embedded_text), f'pages': repr(self.pages), f'tokens': repr(self.tokens), f'metadata': repr(self.metadata), f'page_markdown': repr(self.page_markdown), f'extracted_page_text': repr(self.extracted_page_text), f'augmented_page_text': repr(self.augmented_page_text)} class_name = "DocumentData" repr_str = ',\n '.join([f'{key}={value}' for key, value in repr_dict.items( ) if getattr(self, key, None) is not None and key not in self.deprecated_keys]) @@ -50,6 +52,6 @@ def to_dict(self): Returns: dict: The dict value representation of the class parameters """ - resp = {'doc_id': self.doc_id, 'mime_type': self.mime_type, 'page_count': self.page_count, 'total_page_count': self.total_page_count, 'extracted_text': self.extracted_text, - 'embedded_text': self.embedded_text, 'pages': self.pages, 'tokens': self.tokens, 'metadata': self.metadata, 'page_markdown': self.page_markdown, 'extracted_page_text': self.extracted_page_text} + resp = {'doc_id': self.doc_id, 'mime_type': self.mime_type, 'page_count': self.page_count, 'total_page_count': self.total_page_count, 'extracted_text': self.extracted_text, 'embedded_text': self.embedded_text, + 'pages': self.pages, 'tokens': self.tokens, 'metadata': self.metadata, 'page_markdown': self.page_markdown, 'extracted_page_text': self.extracted_page_text, 'augmented_page_text': self.augmented_page_text} return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys} diff --git a/abacusai/feature_group.py b/abacusai/feature_group.py index 357fb5560..6e530efd9 100644 --- a/abacusai/feature_group.py +++ b/abacusai/feature_group.py @@ -2,7 +2,7 @@ from typing import List, Union from .annotation_config import AnnotationConfig -from .api_class import MergeConfig, ProjectFeatureGroupConfig, SamplingConfig +from .api_class import CPUSize, MemorySize, MergeConfig, OperatorConfig, ProjectFeatureGroupConfig, SamplingConfig from .code_source import CodeSource from .concatenation_config import ConcatenationConfig from .feature import Feature @@ -43,7 +43,6 @@ class FeatureGroup(AbstractApiClass): streamingEnabled (bool): If true, the feature group can have data streamed to it. incremental (bool): If feature group corresponds to an incremental dataset. mergeConfig (dict): Merge configuration settings for the feature group. - operatorConfig (dict): Operator configuration settings for the feature group. samplingConfig (dict): Sampling configuration for the feature group. cpuSize (str): CPU size specified for the Python feature group. memory (int): Memory in GB specified for the Python feature group. @@ -67,9 +66,10 @@ class FeatureGroup(AbstractApiClass): featureGroupTemplate (FeatureGroupTemplate): FeatureGroupTemplate to use when this feature group is attached to a template. explanation (NaturalLanguageExplanation): Natural language explanation of the feature group refreshSchedules (RefreshSchedule): List of schedules that determines when the next version of the feature group will be created. + operatorConfig (OperatorConfig): Operator configuration settings for the feature group. """ - def __init__(self, client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}): + def __init__(self, client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}, operatorConfig={}): super().__init__(client, featureGroupId) self.feature_group_id = featureGroupId self.modification_lock = modificationLock @@ -93,7 +93,6 @@ def __init__(self, client, featureGroupId=None, modificationLock=None, name=None self.streaming_enabled = streamingEnabled self.incremental = incremental self.merge_config = mergeConfig - self.operator_config = operatorConfig self.sampling_config = samplingConfig self.cpu_size = cpuSize self.memory = memory @@ -126,11 +125,13 @@ def __init__(self, client, featureGroupId=None, modificationLock=None, name=None RefreshSchedule, refreshSchedules) self.latest_feature_group_version = client._build_class( FeatureGroupVersion, latestFeatureGroupVersion) + self.operator_config = client._build_class( + OperatorConfig, operatorConfig) self.deprecated_keys = {'name'} def __repr__(self): - repr_dict = {f'feature_group_id': repr(self.feature_group_id), f'modification_lock': repr(self.modification_lock), f'name': repr(self.name), f'feature_group_source_type': repr(self.feature_group_source_type), f'table_name': repr(self.table_name), f'sql': repr(self.sql), f'dataset_id': repr(self.dataset_id), f'function_source_code': repr(self.function_source_code), f'function_name': repr(self.function_name), f'source_tables': repr(self.source_tables), f'created_at': repr(self.created_at), f'description': repr(self.description), f'sql_error': repr(self.sql_error), f'latest_version_outdated': repr(self.latest_version_outdated), f'referenced_feature_groups': repr(self.referenced_feature_groups), f'tags': repr(self.tags), f'primary_key': repr(self.primary_key), f'update_timestamp_key': repr(self.update_timestamp_key), f'lookup_keys': repr(self.lookup_keys), f'streaming_enabled': repr(self.streaming_enabled), f'incremental': repr(self.incremental), f'merge_config': repr(self.merge_config), f'operator_config': repr(self.operator_config), f'sampling_config': repr(self.sampling_config), f'cpu_size': repr( - self.cpu_size), f'memory': repr(self.memory), f'streaming_ready': repr(self.streaming_ready), f'feature_tags': repr(self.feature_tags), f'module_name': repr(self.module_name), f'template_bindings': repr(self.template_bindings), f'feature_expression': repr(self.feature_expression), f'use_original_csv_names': repr(self.use_original_csv_names), f'python_function_bindings': repr(self.python_function_bindings), f'python_function_name': repr(self.python_function_name), f'use_gpu': repr(self.use_gpu), f'features': repr(self.features), f'duplicate_features': repr(self.duplicate_features), f'point_in_time_groups': repr(self.point_in_time_groups), f'annotation_config': repr(self.annotation_config), f'concatenation_config': repr(self.concatenation_config), f'indexing_config': repr(self.indexing_config), f'code_source': repr(self.code_source), f'feature_group_template': repr(self.feature_group_template), f'explanation': repr(self.explanation), f'refresh_schedules': repr(self.refresh_schedules), f'latest_feature_group_version': repr(self.latest_feature_group_version)} + repr_dict = {f'feature_group_id': repr(self.feature_group_id), f'modification_lock': repr(self.modification_lock), f'name': repr(self.name), f'feature_group_source_type': repr(self.feature_group_source_type), f'table_name': repr(self.table_name), f'sql': repr(self.sql), f'dataset_id': repr(self.dataset_id), f'function_source_code': repr(self.function_source_code), f'function_name': repr(self.function_name), f'source_tables': repr(self.source_tables), f'created_at': repr(self.created_at), f'description': repr(self.description), f'sql_error': repr(self.sql_error), f'latest_version_outdated': repr(self.latest_version_outdated), f'referenced_feature_groups': repr(self.referenced_feature_groups), f'tags': repr(self.tags), f'primary_key': repr(self.primary_key), f'update_timestamp_key': repr(self.update_timestamp_key), f'lookup_keys': repr(self.lookup_keys), f'streaming_enabled': repr(self.streaming_enabled), f'incremental': repr(self.incremental), f'merge_config': repr(self.merge_config), f'sampling_config': repr(self.sampling_config), f'cpu_size': repr(self.cpu_size), f'memory': repr( + self.memory), f'streaming_ready': repr(self.streaming_ready), f'feature_tags': repr(self.feature_tags), f'module_name': repr(self.module_name), f'template_bindings': repr(self.template_bindings), f'feature_expression': repr(self.feature_expression), f'use_original_csv_names': repr(self.use_original_csv_names), f'python_function_bindings': repr(self.python_function_bindings), f'python_function_name': repr(self.python_function_name), f'use_gpu': repr(self.use_gpu), f'features': repr(self.features), f'duplicate_features': repr(self.duplicate_features), f'point_in_time_groups': repr(self.point_in_time_groups), f'annotation_config': repr(self.annotation_config), f'concatenation_config': repr(self.concatenation_config), f'indexing_config': repr(self.indexing_config), f'code_source': repr(self.code_source), f'feature_group_template': repr(self.feature_group_template), f'explanation': repr(self.explanation), f'refresh_schedules': repr(self.refresh_schedules), f'latest_feature_group_version': repr(self.latest_feature_group_version), f'operator_config': repr(self.operator_config)} class_name = "FeatureGroup" repr_str = ',\n '.join([f'{key}={value}' for key, value in repr_dict.items( ) if getattr(self, key, None) is not None and key not in self.deprecated_keys]) @@ -143,8 +144,8 @@ def to_dict(self): Returns: dict: The dict value representation of the class parameters """ - resp = {'feature_group_id': self.feature_group_id, 'modification_lock': self.modification_lock, 'name': self.name, 'feature_group_source_type': self.feature_group_source_type, 'table_name': self.table_name, 'sql': self.sql, 'dataset_id': self.dataset_id, 'function_source_code': self.function_source_code, 'function_name': self.function_name, 'source_tables': self.source_tables, 'created_at': self.created_at, 'description': self.description, 'sql_error': self.sql_error, 'latest_version_outdated': self.latest_version_outdated, 'referenced_feature_groups': self.referenced_feature_groups, 'tags': self.tags, 'primary_key': self.primary_key, 'update_timestamp_key': self.update_timestamp_key, 'lookup_keys': self.lookup_keys, 'streaming_enabled': self.streaming_enabled, 'incremental': self.incremental, 'merge_config': self.merge_config, 'operator_config': self.operator_config, 'sampling_config': self.sampling_config, 'cpu_size': self.cpu_size, 'memory': self.memory, 'streaming_ready': self.streaming_ready, 'feature_tags': self.feature_tags, 'module_name': self.module_name, - 'template_bindings': self.template_bindings, 'feature_expression': self.feature_expression, 'use_original_csv_names': self.use_original_csv_names, 'python_function_bindings': self.python_function_bindings, 'python_function_name': self.python_function_name, 'use_gpu': self.use_gpu, 'features': self._get_attribute_as_dict(self.features), 'duplicate_features': self._get_attribute_as_dict(self.duplicate_features), 'point_in_time_groups': self._get_attribute_as_dict(self.point_in_time_groups), 'annotation_config': self._get_attribute_as_dict(self.annotation_config), 'concatenation_config': self._get_attribute_as_dict(self.concatenation_config), 'indexing_config': self._get_attribute_as_dict(self.indexing_config), 'code_source': self._get_attribute_as_dict(self.code_source), 'feature_group_template': self._get_attribute_as_dict(self.feature_group_template), 'explanation': self._get_attribute_as_dict(self.explanation), 'refresh_schedules': self._get_attribute_as_dict(self.refresh_schedules), 'latest_feature_group_version': self._get_attribute_as_dict(self.latest_feature_group_version)} + resp = {'feature_group_id': self.feature_group_id, 'modification_lock': self.modification_lock, 'name': self.name, 'feature_group_source_type': self.feature_group_source_type, 'table_name': self.table_name, 'sql': self.sql, 'dataset_id': self.dataset_id, 'function_source_code': self.function_source_code, 'function_name': self.function_name, 'source_tables': self.source_tables, 'created_at': self.created_at, 'description': self.description, 'sql_error': self.sql_error, 'latest_version_outdated': self.latest_version_outdated, 'referenced_feature_groups': self.referenced_feature_groups, 'tags': self.tags, 'primary_key': self.primary_key, 'update_timestamp_key': self.update_timestamp_key, 'lookup_keys': self.lookup_keys, 'streaming_enabled': self.streaming_enabled, 'incremental': self.incremental, 'merge_config': self.merge_config, 'sampling_config': self.sampling_config, 'cpu_size': self.cpu_size, 'memory': self.memory, 'streaming_ready': self.streaming_ready, 'feature_tags': self.feature_tags, 'module_name': self.module_name, 'template_bindings': self.template_bindings, + 'feature_expression': self.feature_expression, 'use_original_csv_names': self.use_original_csv_names, 'python_function_bindings': self.python_function_bindings, 'python_function_name': self.python_function_name, 'use_gpu': self.use_gpu, 'features': self._get_attribute_as_dict(self.features), 'duplicate_features': self._get_attribute_as_dict(self.duplicate_features), 'point_in_time_groups': self._get_attribute_as_dict(self.point_in_time_groups), 'annotation_config': self._get_attribute_as_dict(self.annotation_config), 'concatenation_config': self._get_attribute_as_dict(self.concatenation_config), 'indexing_config': self._get_attribute_as_dict(self.indexing_config), 'code_source': self._get_attribute_as_dict(self.code_source), 'feature_group_template': self._get_attribute_as_dict(self.feature_group_template), 'explanation': self._get_attribute_as_dict(self.explanation), 'refresh_schedules': self._get_attribute_as_dict(self.refresh_schedules), 'latest_feature_group_version': self._get_attribute_as_dict(self.latest_feature_group_version), 'operator_config': self._get_attribute_as_dict(self.operator_config)} return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys} def add_to_project(self, project_id: str, feature_group_type: str = 'CUSTOM_TABLE'): @@ -324,12 +325,15 @@ def set_merge_config(self, merge_config: Union[dict, MergeConfig]): """ return self.client.set_feature_group_merge_config(self.feature_group_id, merge_config) - def set_operator_config(self, operator_config: dict): + def set_operator_config(self, operator_config: Union[dict, OperatorConfig]): """ Set a OperatorFeatureGroup’s operator config to the values provided. Args: - operator_config (dict): A dictionary object specifying the pre-defined operations. + operator_config (OperatorConfig): A dictionary object specifying the pre-defined operations. + + Returns: + FeatureGroup: The updated FeatureGroup. """ return self.client.set_feature_group_operator_config(self.feature_group_id, operator_config) @@ -795,7 +799,7 @@ def update_python_function_bindings(self, python_function_bindings: List): """ return self.client.update_feature_group_python_function_bindings(self.feature_group_id, python_function_bindings) - def update_python_function(self, python_function_name: str, python_function_bindings: List = None, cpu_size: str = None, memory: int = None, use_gpu: bool = None, use_original_csv_names: bool = None): + def update_python_function(self, python_function_name: str, python_function_bindings: List = None, cpu_size: Union[dict, CPUSize] = None, memory: Union[dict, MemorySize] = None, use_gpu: bool = None, use_original_csv_names: bool = None): """ Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function @@ -806,8 +810,8 @@ def update_python_function(self, python_function_name: str, python_function_bind Args: python_function_name (str): The name of the python function to be associated with the feature group. python_function_bindings (List): List of python function arguments. - cpu_size (str): Size of the CPU for the feature group python function. - memory (int): Memory (in GB) for the feature group python function. + cpu_size (CPUSize): Size of the CPU for the feature group python function. + memory (MemorySize): Memory (in GB) for the feature group python function. use_gpu (bool): Whether the feature group needs a gpu or not. Otherwise default to CPU. use_original_csv_names (bool): If enabled, it uses the original column names for input feature groups from CSV datasets. """ diff --git a/abacusai/page_data.py b/abacusai/page_data.py index 707a257fc..758564735 100644 --- a/abacusai/page_data.py +++ b/abacusai/page_data.py @@ -18,10 +18,11 @@ class PageData(AbstractApiClass): tokens (list): The tokens in the page. extractedText (str): The extracted text in the page obtained from OCR. rotationAngle (float): The detected rotation angle of the page in degrees. Positive values indicate clockwise and negative values indicate anti-clockwise rotation from the original orientation. - pageMarkdown (list): The markdown text for the page. + pageMarkdown (str): The markdown text for the page. + embeddedText (str): The embedded text in the page. Only available for digital documents. """ - def __init__(self, client, docId=None, page=None, height=None, width=None, pageCount=None, pageText=None, pageTokenStartOffset=None, tokenCount=None, tokens=None, extractedText=None, rotationAngle=None, pageMarkdown=None): + def __init__(self, client, docId=None, page=None, height=None, width=None, pageCount=None, pageText=None, pageTokenStartOffset=None, tokenCount=None, tokens=None, extractedText=None, rotationAngle=None, pageMarkdown=None, embeddedText=None): super().__init__(client, None) self.doc_id = docId self.page = page @@ -35,11 +36,12 @@ def __init__(self, client, docId=None, page=None, height=None, width=None, pageC self.extracted_text = extractedText self.rotation_angle = rotationAngle self.page_markdown = pageMarkdown + self.embedded_text = embeddedText self.deprecated_keys = {} def __repr__(self): repr_dict = {f'doc_id': repr(self.doc_id), f'page': repr(self.page), f'height': repr(self.height), f'width': repr(self.width), f'page_count': repr(self.page_count), f'page_text': repr(self.page_text), f'page_token_start_offset': repr( - self.page_token_start_offset), f'token_count': repr(self.token_count), f'tokens': repr(self.tokens), f'extracted_text': repr(self.extracted_text), f'rotation_angle': repr(self.rotation_angle), f'page_markdown': repr(self.page_markdown)} + self.page_token_start_offset), f'token_count': repr(self.token_count), f'tokens': repr(self.tokens), f'extracted_text': repr(self.extracted_text), f'rotation_angle': repr(self.rotation_angle), f'page_markdown': repr(self.page_markdown), f'embedded_text': repr(self.embedded_text)} class_name = "PageData" repr_str = ',\n '.join([f'{key}={value}' for key, value in repr_dict.items( ) if getattr(self, key, None) is not None and key not in self.deprecated_keys]) @@ -53,5 +55,5 @@ def to_dict(self): dict: The dict value representation of the class parameters """ resp = {'doc_id': self.doc_id, 'page': self.page, 'height': self.height, 'width': self.width, 'page_count': self.page_count, 'page_text': self.page_text, 'page_token_start_offset': self.page_token_start_offset, - 'token_count': self.token_count, 'tokens': self.tokens, 'extracted_text': self.extracted_text, 'rotation_angle': self.rotation_angle, 'page_markdown': self.page_markdown} + 'token_count': self.token_count, 'tokens': self.tokens, 'extracted_text': self.extracted_text, 'rotation_angle': self.rotation_angle, 'page_markdown': self.page_markdown, 'embedded_text': self.embedded_text} return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys} diff --git a/abacusai/project.py b/abacusai/project.py index 1a59e52a7..fa2050924 100644 --- a/abacusai/project.py +++ b/abacusai/project.py @@ -298,7 +298,7 @@ def get_custom_train_function_info(self, feature_group_names_for_training: list """ return self.client.get_custom_train_function_info(self.project_id, feature_group_names_for_training, training_data_parameter_name_override, training_config, custom_algorithm_config) - def create_model_monitor(self, prediction_feature_group_id: str, training_feature_group_id: str = None, name: str = None, refresh_schedule: str = None, target_value: str = None, target_value_bias: str = None, target_value_performance: str = None, feature_mappings: dict = None, model_id: str = None, training_feature_mappings: dict = None, feature_group_base_monitor_config: dict = None, feature_group_comparison_monitor_config: dict = None, include_interactive_performance_analysis: bool = False): + def create_model_monitor(self, prediction_feature_group_id: str, training_feature_group_id: str = None, name: str = None, refresh_schedule: str = None, target_value: str = None, target_value_bias: str = None, target_value_performance: str = None, feature_mappings: dict = None, model_id: str = None, training_feature_mappings: dict = None, feature_group_base_monitor_config: dict = None, feature_group_comparison_monitor_config: dict = None, exclude_interactive_performance_analysis: bool = True, exclude_bias_analysis: bool = None, exclude_performance_analysis: bool = None, exclude_feature_drift_analysis: bool = None, exclude_data_integrity_analysis: bool = None): """ Runs a model monitor for the specified project. @@ -315,12 +315,16 @@ def create_model_monitor(self, prediction_feature_group_id: str, training_featur training_feature_mappings (dict): A JSON map to override features for training_fature_group, where keys are column names and the values are feature data use types. feature_group_base_monitor_config (dict): Selection strategy for the feature_group 1 with the feature group version if selected. feature_group_comparison_monitor_config (dict): Selection strategy for the feature_group 1 with the feature group version if selected. - include_interactive_performance_analysis (bool): Whether to include interactive performance analysis. + exclude_interactive_performance_analysis (bool): Whether to exclude interactive performance analysis. Defaults to True if not provided. + exclude_bias_analysis (bool): Whether to exclude bias analysis in the model monitor. For default value bias analysis is included. + exclude_performance_analysis (bool): Whether to exclude performance analysis in the model monitor. For default value performance analysis is included. + exclude_feature_drift_analysis (bool): Whether to exclude feature drift analysis in the model monitor. For default value feature drift analysis is included. + exclude_data_integrity_analysis (bool): Whether to exclude data integrity analysis in the model monitor. For default value data integrity analysis is included. Returns: ModelMonitor: The new model monitor that was created. """ - return self.client.create_model_monitor(self.project_id, prediction_feature_group_id, training_feature_group_id, name, refresh_schedule, target_value, target_value_bias, target_value_performance, feature_mappings, model_id, training_feature_mappings, feature_group_base_monitor_config, feature_group_comparison_monitor_config, include_interactive_performance_analysis) + return self.client.create_model_monitor(self.project_id, prediction_feature_group_id, training_feature_group_id, name, refresh_schedule, target_value, target_value_bias, target_value_performance, feature_mappings, model_id, training_feature_mappings, feature_group_base_monitor_config, feature_group_comparison_monitor_config, exclude_interactive_performance_analysis, exclude_bias_analysis, exclude_performance_analysis, exclude_feature_drift_analysis, exclude_data_integrity_analysis) def list_model_monitors(self): """ diff --git a/abacusai/project_feature_group.py b/abacusai/project_feature_group.py index a9854156f..e94507302 100644 --- a/abacusai/project_feature_group.py +++ b/abacusai/project_feature_group.py @@ -1,4 +1,5 @@ from .annotation_config import AnnotationConfig +from .api_class import OperatorConfig from .code_source import CodeSource from .concatenation_config import ConcatenationConfig from .feature import Feature @@ -41,7 +42,6 @@ class ProjectFeatureGroup(FeatureGroup): streamingEnabled (bool): If true, the feature group can have data streamed to it. incremental (bool): If feature group corresponds to an incremental dataset. mergeConfig (dict): Merge configuration settings for the feature group. - operatorConfig (dict): Operator configuration settings for the feature group. samplingConfig (dict): Sampling configuration for the feature group. cpuSize (str): CPU size specified for the Python feature group. memory (int): Memory in GB specified for the Python feature group. @@ -68,9 +68,10 @@ class ProjectFeatureGroup(FeatureGroup): refreshSchedules (RefreshSchedule): List of schedules that determines when the next version of the feature group will be created. projectFeatureGroupSchema (ProjectFeatureGroupSchema): Project-specific schema for this feature group. projectConfig (ProjectConfig): Project-specific config for this feature group. + operatorConfig (OperatorConfig): Operator configuration settings for the feature group. """ - def __init__(self, client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, featureGroupType=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, projectFeatureGroupSchema={}, projectConfig={}, latestFeatureGroupVersion={}): + def __init__(self, client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, featureGroupType=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, projectFeatureGroupSchema={}, projectConfig={}, latestFeatureGroupVersion={}, operatorConfig={}): super().__init__(client, featureGroupId) self.feature_group_id = featureGroupId self.modification_lock = modificationLock @@ -94,7 +95,6 @@ def __init__(self, client, featureGroupId=None, modificationLock=None, name=None self.streaming_enabled = streamingEnabled self.incremental = incremental self.merge_config = mergeConfig - self.operator_config = operatorConfig self.sampling_config = samplingConfig self.cpu_size = cpuSize self.memory = memory @@ -131,11 +131,13 @@ def __init__(self, client, featureGroupId=None, modificationLock=None, name=None self.project_config = client._build_class(ProjectConfig, projectConfig) self.latest_feature_group_version = client._build_class( FeatureGroupVersion, latestFeatureGroupVersion) + self.operator_config = client._build_class( + OperatorConfig, operatorConfig) self.deprecated_keys = {'name'} def __repr__(self): - repr_dict = {f'feature_group_id': repr(self.feature_group_id), f'modification_lock': repr(self.modification_lock), f'name': repr(self.name), f'feature_group_source_type': repr(self.feature_group_source_type), f'table_name': repr(self.table_name), f'sql': repr(self.sql), f'dataset_id': repr(self.dataset_id), f'function_source_code': repr(self.function_source_code), f'function_name': repr(self.function_name), f'source_tables': repr(self.source_tables), f'created_at': repr(self.created_at), f'description': repr(self.description), f'sql_error': repr(self.sql_error), f'latest_version_outdated': repr(self.latest_version_outdated), f'referenced_feature_groups': repr(self.referenced_feature_groups), f'tags': repr(self.tags), f'primary_key': repr(self.primary_key), f'update_timestamp_key': repr(self.update_timestamp_key), f'lookup_keys': repr(self.lookup_keys), f'streaming_enabled': repr(self.streaming_enabled), f'incremental': repr(self.incremental), f'merge_config': repr(self.merge_config), f'operator_config': repr(self.operator_config), f'sampling_config': repr(self.sampling_config), f'cpu_size': repr(self.cpu_size), f'memory': repr(self.memory), f'streaming_ready': repr( - self.streaming_ready), f'feature_tags': repr(self.feature_tags), f'module_name': repr(self.module_name), f'template_bindings': repr(self.template_bindings), f'feature_expression': repr(self.feature_expression), f'use_original_csv_names': repr(self.use_original_csv_names), f'python_function_bindings': repr(self.python_function_bindings), f'python_function_name': repr(self.python_function_name), f'use_gpu': repr(self.use_gpu), f'feature_group_type': repr(self.feature_group_type), f'features': repr(self.features), f'duplicate_features': repr(self.duplicate_features), f'point_in_time_groups': repr(self.point_in_time_groups), f'annotation_config': repr(self.annotation_config), f'concatenation_config': repr(self.concatenation_config), f'indexing_config': repr(self.indexing_config), f'code_source': repr(self.code_source), f'feature_group_template': repr(self.feature_group_template), f'explanation': repr(self.explanation), f'refresh_schedules': repr(self.refresh_schedules), f'project_feature_group_schema': repr(self.project_feature_group_schema), f'project_config': repr(self.project_config), f'latest_feature_group_version': repr(self.latest_feature_group_version)} + repr_dict = {f'feature_group_id': repr(self.feature_group_id), f'modification_lock': repr(self.modification_lock), f'name': repr(self.name), f'feature_group_source_type': repr(self.feature_group_source_type), f'table_name': repr(self.table_name), f'sql': repr(self.sql), f'dataset_id': repr(self.dataset_id), f'function_source_code': repr(self.function_source_code), f'function_name': repr(self.function_name), f'source_tables': repr(self.source_tables), f'created_at': repr(self.created_at), f'description': repr(self.description), f'sql_error': repr(self.sql_error), f'latest_version_outdated': repr(self.latest_version_outdated), f'referenced_feature_groups': repr(self.referenced_feature_groups), f'tags': repr(self.tags), f'primary_key': repr(self.primary_key), f'update_timestamp_key': repr(self.update_timestamp_key), f'lookup_keys': repr(self.lookup_keys), f'streaming_enabled': repr(self.streaming_enabled), f'incremental': repr(self.incremental), f'merge_config': repr(self.merge_config), f'sampling_config': repr(self.sampling_config), f'cpu_size': repr(self.cpu_size), f'memory': repr(self.memory), f'streaming_ready': repr(self.streaming_ready), f'feature_tags': repr( + self.feature_tags), f'module_name': repr(self.module_name), f'template_bindings': repr(self.template_bindings), f'feature_expression': repr(self.feature_expression), f'use_original_csv_names': repr(self.use_original_csv_names), f'python_function_bindings': repr(self.python_function_bindings), f'python_function_name': repr(self.python_function_name), f'use_gpu': repr(self.use_gpu), f'feature_group_type': repr(self.feature_group_type), f'features': repr(self.features), f'duplicate_features': repr(self.duplicate_features), f'point_in_time_groups': repr(self.point_in_time_groups), f'annotation_config': repr(self.annotation_config), f'concatenation_config': repr(self.concatenation_config), f'indexing_config': repr(self.indexing_config), f'code_source': repr(self.code_source), f'feature_group_template': repr(self.feature_group_template), f'explanation': repr(self.explanation), f'refresh_schedules': repr(self.refresh_schedules), f'project_feature_group_schema': repr(self.project_feature_group_schema), f'project_config': repr(self.project_config), f'latest_feature_group_version': repr(self.latest_feature_group_version), f'operator_config': repr(self.operator_config)} class_name = "ProjectFeatureGroup" repr_str = ',\n '.join([f'{key}={value}' for key, value in repr_dict.items( ) if getattr(self, key, None) is not None and key not in self.deprecated_keys]) @@ -148,6 +150,6 @@ def to_dict(self): Returns: dict: The dict value representation of the class parameters """ - resp = {'feature_group_id': self.feature_group_id, 'modification_lock': self.modification_lock, 'name': self.name, 'feature_group_source_type': self.feature_group_source_type, 'table_name': self.table_name, 'sql': self.sql, 'dataset_id': self.dataset_id, 'function_source_code': self.function_source_code, 'function_name': self.function_name, 'source_tables': self.source_tables, 'created_at': self.created_at, 'description': self.description, 'sql_error': self.sql_error, 'latest_version_outdated': self.latest_version_outdated, 'referenced_feature_groups': self.referenced_feature_groups, 'tags': self.tags, 'primary_key': self.primary_key, 'update_timestamp_key': self.update_timestamp_key, 'lookup_keys': self.lookup_keys, 'streaming_enabled': self.streaming_enabled, 'incremental': self.incremental, 'merge_config': self.merge_config, 'operator_config': self.operator_config, 'sampling_config': self.sampling_config, 'cpu_size': self.cpu_size, 'memory': self.memory, 'streaming_ready': self.streaming_ready, 'feature_tags': self.feature_tags, 'module_name': self.module_name, 'template_bindings': self.template_bindings, 'feature_expression': self.feature_expression, - 'use_original_csv_names': self.use_original_csv_names, 'python_function_bindings': self.python_function_bindings, 'python_function_name': self.python_function_name, 'use_gpu': self.use_gpu, 'feature_group_type': self.feature_group_type, 'features': self._get_attribute_as_dict(self.features), 'duplicate_features': self._get_attribute_as_dict(self.duplicate_features), 'point_in_time_groups': self._get_attribute_as_dict(self.point_in_time_groups), 'annotation_config': self._get_attribute_as_dict(self.annotation_config), 'concatenation_config': self._get_attribute_as_dict(self.concatenation_config), 'indexing_config': self._get_attribute_as_dict(self.indexing_config), 'code_source': self._get_attribute_as_dict(self.code_source), 'feature_group_template': self._get_attribute_as_dict(self.feature_group_template), 'explanation': self._get_attribute_as_dict(self.explanation), 'refresh_schedules': self._get_attribute_as_dict(self.refresh_schedules), 'project_feature_group_schema': self._get_attribute_as_dict(self.project_feature_group_schema), 'project_config': self._get_attribute_as_dict(self.project_config), 'latest_feature_group_version': self._get_attribute_as_dict(self.latest_feature_group_version)} + resp = {'feature_group_id': self.feature_group_id, 'modification_lock': self.modification_lock, 'name': self.name, 'feature_group_source_type': self.feature_group_source_type, 'table_name': self.table_name, 'sql': self.sql, 'dataset_id': self.dataset_id, 'function_source_code': self.function_source_code, 'function_name': self.function_name, 'source_tables': self.source_tables, 'created_at': self.created_at, 'description': self.description, 'sql_error': self.sql_error, 'latest_version_outdated': self.latest_version_outdated, 'referenced_feature_groups': self.referenced_feature_groups, 'tags': self.tags, 'primary_key': self.primary_key, 'update_timestamp_key': self.update_timestamp_key, 'lookup_keys': self.lookup_keys, 'streaming_enabled': self.streaming_enabled, 'incremental': self.incremental, 'merge_config': self.merge_config, 'sampling_config': self.sampling_config, 'cpu_size': self.cpu_size, 'memory': self.memory, 'streaming_ready': self.streaming_ready, 'feature_tags': self.feature_tags, 'module_name': self.module_name, 'template_bindings': self.template_bindings, 'feature_expression': self.feature_expression, 'use_original_csv_names': self.use_original_csv_names, + 'python_function_bindings': self.python_function_bindings, 'python_function_name': self.python_function_name, 'use_gpu': self.use_gpu, 'feature_group_type': self.feature_group_type, 'features': self._get_attribute_as_dict(self.features), 'duplicate_features': self._get_attribute_as_dict(self.duplicate_features), 'point_in_time_groups': self._get_attribute_as_dict(self.point_in_time_groups), 'annotation_config': self._get_attribute_as_dict(self.annotation_config), 'concatenation_config': self._get_attribute_as_dict(self.concatenation_config), 'indexing_config': self._get_attribute_as_dict(self.indexing_config), 'code_source': self._get_attribute_as_dict(self.code_source), 'feature_group_template': self._get_attribute_as_dict(self.feature_group_template), 'explanation': self._get_attribute_as_dict(self.explanation), 'refresh_schedules': self._get_attribute_as_dict(self.refresh_schedules), 'project_feature_group_schema': self._get_attribute_as_dict(self.project_feature_group_schema), 'project_config': self._get_attribute_as_dict(self.project_config), 'latest_feature_group_version': self._get_attribute_as_dict(self.latest_feature_group_version), 'operator_config': self._get_attribute_as_dict(self.operator_config)} return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys} diff --git a/abacusai/public.pem b/abacusai/public.pem index 729993638..dacec7a2e 100644 --- a/abacusai/public.pem +++ b/abacusai/public.pem @@ -1,5 +1,5 @@ -----BEGIN RSA PUBLIC KEY----- -MIGJAoGBAJAwf7WFwJfO+yv1GoJwhsDlMxEdobU8L9MLogH33EtlkfpHIP54O1f7 -Rxr8BJJI//ntLdDEdbGEatig6vO1TAKBHoUvZ8h7lifAGu6o+RqGH3HNdYPHY0/P -qYQMYFWv0nxSf45aZkKcGHjbWb9wVy/mKBNYukC/bmYXopgdPa3FAgMBAAE= +MIGJAoGBAPOAbyqA+DtaonL64t1ylgJxVqCF8aybL5oAu7xlOkFaj5KhHcTgj/9/ +cjoJ3O9Y77n8zUZqFLMcoc3HCoNkJynIHTUke6fWFbMwVX1gqR57Wtx4rJ+W3qOG +gBdUFm9aUe/B+Bo8bqsn2HlYa+xhNfw7+E0+JBUjdnh6Xd5QqfnLAgMBAAE= -----END RSA PUBLIC KEY----- diff --git a/docs/.buildinfo b/docs/.buildinfo index ba9404707..44fe85bab 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9cd0e17cedd3a5aab3432b70872522db +config: 4fdbf1dcafc70127065e01326c9151ce tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/autoapi/abacusai/abacus_api/index.rst.txt b/docs/_sources/autoapi/abacusai/abacus_api/index.rst.txt index cb551a3c4..10908ef76 100644 --- a/docs/_sources/autoapi/abacusai/abacus_api/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/abacus_api/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.abacus_api -=================== +:py:mod:`abacusai.abacus_api` +============================= .. py:module:: abacusai.abacus_api -Classes -------- - -.. autoapisummary:: - - abacusai.abacus_api.AbstractApiClass - abacusai.abacus_api.AbacusApi - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.abacus_api.AbacusApi - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AbacusApi(client, method=None, docstring=None, score=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An Abacus API. @@ -43,13 +33,11 @@ Module Contents :param score: The relevance score of the API method. :type score: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/agent/index.rst.txt b/docs/_sources/autoapi/abacusai/agent/index.rst.txt index b9ee22dd0..1e33102e7 100644 --- a/docs/_sources/autoapi/abacusai/agent/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/agent/index.rst.txt @@ -1,212 +1,26 @@ -abacusai.agent -============== +:py:mod:`abacusai.agent` +======================== .. py:module:: abacusai.agent -Classes -------- - -.. autoapisummary:: - - abacusai.agent.AgentVersion - abacusai.agent.WorkflowGraph - abacusai.agent.CodeSource - abacusai.agent.AbstractApiClass - abacusai.agent.Agent - - Module Contents --------------- -.. py:class:: AgentVersion(client, agentVersion=None, status=None, agentId=None, agentConfig=None, publishingStartedAt=None, publishingCompletedAt=None, pendingDeploymentIds=None, failedDeploymentIds=None, error=None, agentExecutionConfig=None, codeSource={}, workflowGraph={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of an AI agent. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param agentVersion: The unique identifier of an agent version. - :type agentVersion: str - :param status: The current status of the model. - :type status: str - :param agentId: A reference to the agent this version belongs to. - :type agentId: str - :param agentConfig: The config options used to create this agent. - :type agentConfig: dict - :param publishingStartedAt: The start time and date of the training process in ISO-8601 format. - :type publishingStartedAt: str - :param publishingCompletedAt: The end time and date of the training process in ISO-8601 format. - :type publishingCompletedAt: str - :param pendingDeploymentIds: List of deployment IDs where deployment is pending. - :type pendingDeploymentIds: list - :param failedDeploymentIds: List of failed deployment IDs. - :type failedDeploymentIds: list - :param error: Relevant error if the status is FAILED. - :type error: str - :param agentExecutionConfig: The config for arguments used to execute the agent. - :type agentExecutionConfig: dict - :param codeSource: If a python model, information on where the source code is located. - :type codeSource: CodeSource - :param workflowGraph: The workflow graph for the agent. - :type workflowGraph: WorkflowGraph - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: AgentVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified agent version. - - :param agent_version: Unique string identifier of the agent version. - :type agent_version: str - - :returns: A agent version. - :rtype: AgentVersion - - - - .. py:method:: wait_for_publish(timeout=None) - - A waiting call until agent gets published. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model version under training. - - :returns: A string describing the status of a model training (pending, complete, etc.). - :rtype: str - - - -.. py:class:: WorkflowGraph - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. - - :param nodes: A list of nodes in the workflow graph. - :type nodes: List[WorkflowGraphNode] - :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. - :type edges: List[WorkflowGraphEdge] - - - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] - - - .. py:attribute:: edges - :type: List[WorkflowGraphEdge] - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(graph) - :classmethod: - - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.agent.Agent - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Agent(client, name=None, agentId=None, createdAt=None, projectId=None, notebookId=None, predictFunctionName=None, sourceCode=None, agentConfig=None, memory=None, trainingRequired=None, agentExecutionConfig=None, codeSource={}, latestAgentVersion={}, workflowGraph={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An AI agent. @@ -241,13 +55,11 @@ Module Contents :param workflowGraph: The workflow graph for the agent. :type workflowGraph: WorkflowGraph - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -256,7 +68,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -265,7 +76,6 @@ Module Contents :rtype: Agent - .. py:method:: describe() Retrieves a full description of the specified model. @@ -277,7 +87,6 @@ Module Contents :rtype: Agent - .. py:method:: list_versions(limit = 100, start_after_version = None) List all versions of an agent. @@ -291,7 +100,6 @@ Module Contents :rtype: list[AgentVersion] - .. py:method:: wait_for_publish(timeout=None) A waiting call until agent is published. @@ -300,7 +108,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the agent publishing. diff --git a/docs/_sources/autoapi/abacusai/agent_data_document_info/index.rst.txt b/docs/_sources/autoapi/abacusai/agent_data_document_info/index.rst.txt index 0b2a8c37e..a0aa021c3 100644 --- a/docs/_sources/autoapi/abacusai/agent_data_document_info/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/agent_data_document_info/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.agent_data_document_info -================================= +:py:mod:`abacusai.agent_data_document_info` +=========================================== .. py:module:: abacusai.agent_data_document_info -Classes -------- - -.. autoapisummary:: - - abacusai.agent_data_document_info.AbstractApiClass - abacusai.agent_data_document_info.AgentDataDocumentInfo - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.agent_data_document_info.AgentDataDocumentInfo - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AgentDataDocumentInfo(client, docId=None, filename=None, mimeType=None, size=None, pageCount=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Information for documents uploaded to agents. @@ -47,13 +37,11 @@ Module Contents :param pageCount: The total number of pages in the uploaded document. :type pageCount: int - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/agent_data_execution_result/index.rst.txt b/docs/_sources/autoapi/abacusai/agent_data_execution_result/index.rst.txt index 5a68d2c12..f11c1876d 100644 --- a/docs/_sources/autoapi/abacusai/agent_data_execution_result/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/agent_data_execution_result/index.rst.txt @@ -1,73 +1,26 @@ -abacusai.agent_data_execution_result -==================================== +:py:mod:`abacusai.agent_data_execution_result` +============================================== .. py:module:: abacusai.agent_data_execution_result -Classes -------- - -.. autoapisummary:: - - abacusai.agent_data_execution_result.AgentDataDocumentInfo - abacusai.agent_data_execution_result.AbstractApiClass - abacusai.agent_data_execution_result.AgentDataExecutionResult - - Module Contents --------------- -.. py:class:: AgentDataDocumentInfo(client, docId=None, filename=None, mimeType=None, size=None, pageCount=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Information for documents uploaded to agents. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param docId: The docstore Document ID of the document. - :type docId: str - :param filename: The file name of the uploaded document. - :type filename: str - :param mimeType: The mime type of the uploaded document. - :type mimeType: str - :param size: The total size of the uploaded document. - :type size: int - :param pageCount: The total number of pages in the uploaded document. - :type pageCount: int - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.agent_data_execution_result.AgentDataExecutionResult - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AgentDataExecutionResult(client, response=None, deploymentConversationId=None, docInfos={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Results of agent execution with uploaded data. @@ -80,13 +33,11 @@ Module Contents :param docInfos: A list of dict containing information on documents uploaded to agent. :type docInfos: AgentDataDocumentInfo - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/agent_version/index.rst.txt b/docs/_sources/autoapi/abacusai/agent_version/index.rst.txt index f1e1c1aa4..6420f840c 100644 --- a/docs/_sources/autoapi/abacusai/agent_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/agent_version/index.rst.txt @@ -1,122 +1,26 @@ -abacusai.agent_version -====================== +:py:mod:`abacusai.agent_version` +================================ .. py:module:: abacusai.agent_version -Classes -------- - -.. autoapisummary:: - - abacusai.agent_version.WorkflowGraph - abacusai.agent_version.CodeSource - abacusai.agent_version.AbstractApiClass - abacusai.agent_version.AgentVersion - - Module Contents --------------- -.. py:class:: WorkflowGraph - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. - - :param nodes: A list of nodes in the workflow graph. - :type nodes: List[WorkflowGraphNode] - :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. - :type edges: List[WorkflowGraphEdge] - - - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] - - - .. py:attribute:: edges - :type: List[WorkflowGraphEdge] - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(graph) - :classmethod: - - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.agent_version.AgentVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AgentVersion(client, agentVersion=None, status=None, agentId=None, agentConfig=None, publishingStartedAt=None, publishingCompletedAt=None, pendingDeploymentIds=None, failedDeploymentIds=None, error=None, agentExecutionConfig=None, codeSource={}, workflowGraph={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of an AI agent. @@ -147,13 +51,11 @@ Module Contents :param workflowGraph: The workflow graph for the agent. :type workflowGraph: WorkflowGraph - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -162,7 +64,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -171,7 +72,6 @@ Module Contents :rtype: AgentVersion - .. py:method:: describe() Retrieves a full description of the specified agent version. @@ -183,7 +83,6 @@ Module Contents :rtype: AgentVersion - .. py:method:: wait_for_publish(timeout=None) A waiting call until agent gets published. @@ -192,7 +91,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the model version under training. diff --git a/docs/_sources/autoapi/abacusai/ai_building_task/index.rst.txt b/docs/_sources/autoapi/abacusai/ai_building_task/index.rst.txt index 8bec93f64..f66256de8 100644 --- a/docs/_sources/autoapi/abacusai/ai_building_task/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/ai_building_task/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.ai_building_task -========================= +:py:mod:`abacusai.ai_building_task` +=================================== .. py:module:: abacusai.ai_building_task -Classes -------- - -.. autoapisummary:: - - abacusai.ai_building_task.AbstractApiClass - abacusai.ai_building_task.AiBuildingTask - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.ai_building_task.AiBuildingTask - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AiBuildingTask(client, task=None, taskType=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A task for Data Science Co-pilot to help build AI. @@ -41,13 +31,11 @@ Module Contents :param taskType: The type of task :type taskType: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/algorithm/index.rst.txt b/docs/_sources/autoapi/abacusai/algorithm/index.rst.txt index a892c4025..90f84a001 100644 --- a/docs/_sources/autoapi/abacusai/algorithm/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/algorithm/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.algorithm -================== +:py:mod:`abacusai.algorithm` +============================ .. py:module:: abacusai.algorithm -Classes -------- - -.. autoapisummary:: - - abacusai.algorithm.CodeSource - abacusai.algorithm.AbstractApiClass - abacusai.algorithm.Algorithm - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.algorithm.Algorithm - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Algorithm(client, name=None, problemType=None, createdAt=None, updatedAt=None, isDefaultEnabled=None, trainingInputMappings=None, trainFunctionName=None, predictFunctionName=None, predictManyFunctionName=None, initializeFunctionName=None, configOptions=None, algorithmId=None, useGpu=None, algorithmTrainingConfig=None, onlyOfflineDeployable=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Customer created algorithm @@ -120,13 +59,11 @@ Module Contents :param codeSource: Info about the source code of the algorithm :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/annotation/index.rst.txt b/docs/_sources/autoapi/abacusai/annotation/index.rst.txt index 71876ca9a..27d376a84 100644 --- a/docs/_sources/autoapi/abacusai/annotation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/annotation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.annotation -=================== +:py:mod:`abacusai.annotation` +============================= .. py:module:: abacusai.annotation -Classes -------- - -.. autoapisummary:: - - abacusai.annotation.AbstractApiClass - abacusai.annotation.Annotation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.annotation.Annotation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Annotation(client, annotationType=None, annotationValue=None, comments=None, metadata=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An Annotation Store Annotation @@ -45,13 +35,11 @@ Module Contents :param metadata: Metadata about the annotation. :type metadata: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/annotation_config/index.rst.txt b/docs/_sources/autoapi/abacusai/annotation_config/index.rst.txt index 62a349a4b..f15207608 100644 --- a/docs/_sources/autoapi/abacusai/annotation_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/annotation_config/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.annotation_config -========================== +:py:mod:`abacusai.annotation_config` +==================================== .. py:module:: abacusai.annotation_config -Classes -------- - -.. autoapisummary:: - - abacusai.annotation_config.AbstractApiClass - abacusai.annotation_config.AnnotationConfig - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.annotation_config.AnnotationConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Annotation config for a feature group @@ -47,13 +37,11 @@ Module Contents :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional) :type metadataFeature: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/annotation_document/index.rst.txt b/docs/_sources/autoapi/abacusai/annotation_document/index.rst.txt index 09a2188f5..cb5bffaeb 100644 --- a/docs/_sources/autoapi/abacusai/annotation_document/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/annotation_document/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.annotation_document -============================ +:py:mod:`abacusai.annotation_document` +====================================== .. py:module:: abacusai.annotation_document -Classes -------- - -.. autoapisummary:: - - abacusai.annotation_document.AbstractApiClass - abacusai.annotation_document.AnnotationDocument - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.annotation_document.AnnotationDocument - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AnnotationDocument(client, docId=None, featureGroupRowIdentifier=None, featureGroupRowIndex=None, totalRows=None, isAnnotationPresent=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Document to be annotated. @@ -47,13 +37,11 @@ Module Contents :param isAnnotationPresent: Whether the document already has an annotation. Returns None if feature group is not under annotations review mode. :type isAnnotationPresent: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/annotation_entry/index.rst.txt b/docs/_sources/autoapi/abacusai/annotation_entry/index.rst.txt index f2989d0c9..ad3459c73 100644 --- a/docs/_sources/autoapi/abacusai/annotation_entry/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/annotation_entry/index.rst.txt @@ -1,71 +1,26 @@ -abacusai.annotation_entry -========================= +:py:mod:`abacusai.annotation_entry` +=================================== .. py:module:: abacusai.annotation_entry -Classes -------- - -.. autoapisummary:: - - abacusai.annotation_entry.Annotation - abacusai.annotation_entry.AbstractApiClass - abacusai.annotation_entry.AnnotationEntry - - Module Contents --------------- -.. py:class:: Annotation(client, annotationType=None, annotationValue=None, comments=None, metadata=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Annotation Store Annotation - - :param client: An authenticated API Client instance - :type client: ApiClient - :param annotationType: A name determining the type of annotation and how to interpret the annotation value data, e.g. as a label, bounding box, etc. - :type annotationType: str - :param annotationValue: JSON-compatible value of the annotation. The format of the value is determined by the annotation type. - :type annotationValue: dict - :param comments: Comments about the annotation. This is a dictionary of feature name to the corresponding comment. - :type comments: dict - :param metadata: Metadata about the annotation. - :type metadata: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.annotation_entry.AnnotationEntry - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AnnotationEntry(client, featureGroupId=None, featureName=None, docId=None, featureGroupRowIdentifier=None, updatedAt=None, annotationEntryMarker=None, status=None, lockedUntil=None, verificationInfo=None, annotation={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An Annotation Store entry for an Annotation @@ -92,13 +47,11 @@ Module Contents :param annotation: json-compatible structure holding the type and value of the annotation. :type annotation: Annotation - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/annotations_status/index.rst.txt b/docs/_sources/autoapi/abacusai/annotations_status/index.rst.txt index 4c8d91574..912bf05fc 100644 --- a/docs/_sources/autoapi/abacusai/annotations_status/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/annotations_status/index.rst.txt @@ -1,73 +1,26 @@ -abacusai.annotations_status -=========================== +:py:mod:`abacusai.annotations_status` +===================================== .. py:module:: abacusai.annotations_status -Classes -------- - -.. autoapisummary:: - - abacusai.annotations_status.AnnotationConfig - abacusai.annotations_status.AbstractApiClass - abacusai.annotations_status.AnnotationsStatus - - Module Contents --------------- -.. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Annotation config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureAnnotationConfigs: List of feature annotation configs - :type featureAnnotationConfigs: list - :param labels: List of labels - :type labels: list - :param statusFeature: Name of the feature that contains the status of the annotation (Optional) - :type statusFeature: str - :param commentsFeatures: Features that contain comments for the annotation (Optional) - :type commentsFeatures: list - :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional) - :type metadataFeature: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.annotations_status.AnnotationsStatus - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: AnnotationsStatus(client, total=None, done=None, inProgress=None, todo=None, latestUpdatedAt=None, isMaterializationNeeded=None, latestMaterializedAnnotationConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The status of annotations for a feature group @@ -88,13 +41,11 @@ Module Contents :param latestMaterializedAnnotationConfig: The annotation config corresponding to the latest materialized feature group :type latestMaterializedAnnotationConfig: AnnotationConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/api_class/abstract/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/abstract/index.rst.txt index bb0cff810..65fe6f057 100644 --- a/docs/_sources/autoapi/abacusai/api_class/abstract/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/abstract/index.rst.txt @@ -1,30 +1,24 @@ -abacusai.api_class.abstract -=========================== +:py:mod:`abacusai.api_class.abstract` +===================================== .. py:module:: abacusai.api_class.abstract -Attributes ----------- - -.. autoapisummary:: - - abacusai.api_class.abstract.FIRST_CAP_RE - abacusai.api_class.abstract.ALL_CAP_RE - +Module Contents +--------------- Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.abstract.ApiEnum abacusai.api_class.abstract.ApiClass abacusai.api_class.abstract._ApiClassFactory + Functions ---------- +~~~~~~~~~ .. autoapisummary:: @@ -34,59 +28,53 @@ Functions abacusai.api_class.abstract.get_clean_function_source_code -Module Contents ---------------- - -.. py:class:: ApiEnum - - Bases: :py:obj:`enum.Enum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:method:: __eq__(other) - - Return self==value. - - - .. py:method:: __hash__() +Attributes +~~~~~~~~~~ - Return hash(self). +.. autoapisummary:: + abacusai.api_class.abstract.FIRST_CAP_RE + abacusai.api_class.abstract.ALL_CAP_RE .. py:data:: FIRST_CAP_RE + + .. py:data:: ALL_CAP_RE + + .. py:function:: camel_case(value) + .. py:function:: upper_snake_case(value) + .. py:function:: snake_case(value) + .. py:function:: get_clean_function_source_code(func) + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -95,13 +83,11 @@ Module Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -127,7 +113,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -135,25 +120,23 @@ Module Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: diff --git a/docs/_sources/autoapi/abacusai/api_class/ai_agents/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/ai_agents/index.rst.txt index a6b092b6b..cba648f06 100644 --- a/docs/_sources/autoapi/abacusai/api_class/ai_agents/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/ai_agents/index.rst.txt @@ -1,15 +1,17 @@ -abacusai.api_class.ai_agents -============================ +:py:mod:`abacusai.api_class.ai_agents` +====================================== .. py:module:: abacusai.api_class.ai_agents +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.ai_agents.ApiClass abacusai.api_class.ai_agents.FieldDescriptor abacusai.api_class.ai_agents.WorkflowNodeInputSchema abacusai.api_class.ai_agents.WorkflowNodeOutputSchema @@ -20,85 +22,12 @@ Classes abacusai.api_class.ai_agents.WorkflowGraph -Functions ---------- - -.. autoapisummary:: - - abacusai.api_class.ai_agents.get_clean_function_source_code - - -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:function:: get_clean_function_source_code(func) .. py:class:: FieldDescriptor - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Configs for vector store indexing. @@ -111,43 +40,48 @@ Module Contents :param type: The type of this field. If not provided, the default type is STRING. :type type: FieldDescriptorType - .. py:attribute:: field - :type: str + :type: str + .. py:attribute:: description - :type: str + :type: str + .. py:attribute:: example_extraction - :type: Union[str, int, bool, float, list, dict] + :type: Union[str, int, bool, float, list, dict] + .. py:attribute:: type - :type: abacusai.api_class.enums.FieldDescriptorType + :type: abacusai.api_class.enums.FieldDescriptorType + + .. py:class:: WorkflowNodeInputSchema - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A react-jsonschema-form conformant schema for workflow node input. - :param json_schema: The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, File Upload. Not supported - Nested elements, arrays and other complex types. + :param json_schema: The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, file upload. Not supported - Nested elements, arrays and other complex types. :type json_schema: dict :param ui_schema: The ui schema for the input conformant to react-jsonschema-form specification. :type ui_schema: dict - .. py:attribute:: json_schema - :type: dict + :type: dict + .. py:attribute:: ui_schema - :type: dict + :type: dict + .. py:method:: to_dict() @@ -156,7 +90,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(schema) :classmethod: @@ -164,18 +97,18 @@ Module Contents .. py:class:: WorkflowNodeOutputSchema - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A react-jsonschema-form schema for a workflow node output. :param json_schema: The json schema for the output conformant to react-jsonschema-form specification. :type json_schema: dict - .. py:attribute:: json_schema - :type: dict + :type: dict + .. py:method:: to_dict() @@ -184,7 +117,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(schema) :classmethod: @@ -192,8 +124,8 @@ Module Contents .. py:class:: WorkflowNodeInputMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A mapping of input to a workflow node. @@ -209,22 +141,25 @@ Module Contents :param is_required: Whether the input is required. Defaults to True :type is_required: bool - .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: variable_type - :type: abacusai.api_class.enums.WorkflowNodeInputType + :type: abacusai.api_class.enums.WorkflowNodeInputType + .. py:attribute:: variable_source - :type: str + :type: str + .. py:attribute:: is_required - :type: bool + :type: bool + .. py:method:: to_dict() @@ -233,7 +168,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(mapping) :classmethod: @@ -241,8 +175,8 @@ Module Contents .. py:class:: WorkflowNodeOutputMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A mapping of output to a workflow node. @@ -251,14 +185,15 @@ Module Contents :param variable_type: The type of the output. :type variable_type: WorkflowNodeOutputType - .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: variable_type - :type: abacusai.api_class.enums.WorkflowNodeOutputType + :type: abacusai.api_class.enums.WorkflowNodeOutputType + .. py:method:: to_dict() @@ -267,7 +202,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(mapping) :classmethod: @@ -275,8 +209,8 @@ Module Contents .. py:class:: WorkflowGraphNode(name, input_mappings, output_mappings, function = None, function_name = None, source_code = None, input_schema = None, output_schema = None, package_requirements = None) - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A node in an Agent workflow graph. @@ -295,7 +229,6 @@ Module Contents :param package_requirements: List of package requirements for the node. :type package_requirements: list - .. py:method:: to_dict() Standardizes converting an ApiClass to dictionary. @@ -303,7 +236,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(node) :classmethod: @@ -311,8 +243,8 @@ Module Contents .. py:class:: WorkflowGraphEdge - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An edge in an Agent workflow graph. @@ -323,26 +255,29 @@ Module Contents :param details: Additional details about the edge. :type details: dict - .. py:attribute:: source - :type: str + :type: str + .. py:attribute:: target - :type: str + :type: str + .. py:attribute:: details - :type: dict + :type: dict + .. py:method:: to_nx_edge() + .. py:class:: WorkflowGraph - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. @@ -351,14 +286,15 @@ Module Contents :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. :type edges: List[WorkflowGraphEdge] - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] + :type: List[WorkflowGraphNode] + .. py:attribute:: edges - :type: List[WorkflowGraphEdge] + :type: List[WorkflowGraphEdge] + .. py:method:: to_dict() @@ -367,7 +303,6 @@ Module Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(graph) :classmethod: diff --git a/docs/_sources/autoapi/abacusai/api_class/ai_chat/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/ai_chat/index.rst.txt index 01bfda15a..18160a843 100644 --- a/docs/_sources/autoapi/abacusai/api_class/ai_chat/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/ai_chat/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.api_class.ai_chat -========================== +:py:mod:`abacusai.api_class.ai_chat` +==================================== .. py:module:: abacusai.api_class.ai_chat -Classes -------- - -.. autoapisummary:: - - abacusai.api_class.ai_chat.ApiClass - abacusai.api_class.ai_chat.HotkeyPrompt - - Module Contents --------------- -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. +Classes +~~~~~~~ +.. autoapisummary:: + abacusai.api_class.ai_chat.HotkeyPrompt - .. py:method:: from_dict(input_dict) - :classmethod: .. py:class:: HotkeyPrompt - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for a Data Science Co-Pilot Hotkey @@ -90,20 +29,24 @@ Module Contents :param title: A short, descriptive title for the prompt. If not provided, one will be automatically generated. :type title: str - .. py:attribute:: prompt - :type: str + :type: str + .. py:attribute:: title - :type: str + :type: str + .. py:attribute:: disable_problem_type_context - :type: bool + :type: bool + .. py:attribute:: ignore_history - :type: bool + :type: bool + + diff --git a/docs/_sources/autoapi/abacusai/api_class/batch_prediction/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/batch_prediction/index.rst.txt index 85ff2a9c1..b4a37f05e 100644 --- a/docs/_sources/autoapi/abacusai/api_class/batch_prediction/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/batch_prediction/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.batch_prediction -=================================== +:py:mod:`abacusai.api_class.batch_prediction` +============================================= .. py:module:: abacusai.api_class.batch_prediction +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.batch_prediction.ApiClass - abacusai.api_class.batch_prediction._ApiClassFactory abacusai.api_class.batch_prediction.BatchPredictionArgs abacusai.api_class.batch_prediction.ForecastingBatchPredictionArgs abacusai.api_class.batch_prediction.NamedEntityExtractionBatchPredictionArgs @@ -24,117 +25,29 @@ Classes abacusai.api_class.batch_prediction._BatchPredictionArgsFactory -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - .. py:class:: BatchPredictionArgs - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for Batch Prediction args specific to problem type. - .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:method:: _get_builder() :classmethod: @@ -143,8 +56,8 @@ Module Contents .. py:class:: ForecastingBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the FORECASTING problem type @@ -165,64 +78,73 @@ Module Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: predictions_start_date - :type: str + :type: str + .. py:attribute:: use_prediction_offset - :type: bool + :type: bool + .. py:attribute:: start_date_offset - :type: int + :type: int + .. py:attribute:: forecasting_horizon - :type: int + :type: int + .. py:attribute:: item_attributes_to_include_in_the_result - :type: list + :type: list + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NamedEntityExtractionBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the NAMED_ENTITY_EXTRACTION problem type :param for_eval: If True, the test fold which was created during training and used for metrics calculation will be used as input data. These predictions are hence, used for model evaluation. :type for_eval: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: PersonalizationBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PERSONALIZATION problem type @@ -235,30 +157,34 @@ Module Contents :param score_field: If specified, relative item scores will be returned using a field with this name :type score_field: str - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: number_of_items - :type: int + :type: int + .. py:attribute:: item_attributes_to_include_in_the_result - :type: list + :type: list + .. py:attribute:: score_field - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: PredictiveModelingBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PREDICTIVE_MODELING problem type @@ -287,62 +213,74 @@ Module Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: abacusai.api_class.enums.ExplainerType + :type: abacusai.api_class.enums.ExplainerType + .. py:attribute:: number_of_samples_to_use_for_explainer - :type: int + :type: int + .. py:attribute:: include_multi_class_explanations - :type: bool + :type: bool + .. py:attribute:: features_considered_constant_for_explanations - :type: str + :type: str + .. py:attribute:: importance_of_records_in_nested_columns - :type: str + :type: str + .. py:attribute:: explanation_filter_lower_bound - :type: float + :type: float + .. py:attribute:: explanation_filter_upper_bound - :type: float + :type: float + .. py:attribute:: explanation_filter_label - :type: str + :type: str + .. py:attribute:: output_columns - :type: list + :type: list + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: PretrainedModelsBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PRETRAINED_MODELS problem type @@ -353,26 +291,29 @@ Module Contents :param channel_id_to_label_map: JSON string for the map from channel ids to their labels. :type channel_id_to_label_map: str - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: files_output_location_prefix - :type: str + :type: str + .. py:attribute:: channel_id_to_label_map - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: SentenceBoundaryDetectionBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the SENTENCE_BOUNDARY_DETECTION problem type @@ -381,22 +322,24 @@ Module Contents :param explode_output: Explode data so there is one sentence per row. :type explode_output: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: explode_output - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ThemeAnalysisBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the THEME_ANALYSIS problem type @@ -409,48 +352,53 @@ Module Contents :param analysis_days: How many days to analyze. :type analysis_days: int - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: analysis_frequency - :type: str + :type: str + .. py:attribute:: start_date - :type: str + :type: str + .. py:attribute:: analysis_days - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: ChatLLMBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the ChatLLM problem type :param for_eval: If True, the test fold which was created during training and used for metrics calculation will be used as input data. These predictions are hence, used for model evaluation. :type for_eval: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TrainablePlugAndPlayBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the TrainablePlugAndPlay problem type @@ -459,35 +407,39 @@ Module Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _BatchPredictionArgsFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/blob_input/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/blob_input/index.rst.txt index 439aa01ca..e408107e6 100644 --- a/docs/_sources/autoapi/abacusai/api_class/blob_input/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/blob_input/index.rst.txt @@ -1,89 +1,29 @@ -abacusai.api_class.blob_input -============================= +:py:mod:`abacusai.api_class.blob_input` +======================================= .. py:module:: abacusai.api_class.blob_input -Classes -------- - -.. autoapisummary:: - - abacusai.api_class.blob_input.ApiClass - abacusai.api_class.blob_input.BlobInput - - Module Contents --------------- -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() +Classes +~~~~~~~ - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. +.. autoapisummary:: + abacusai.api_class.blob_input.Blob + abacusai.api_class.blob_input.BlobInput - .. py:method:: from_dict(input_dict) - :classmethod: +.. py:class:: Blob(contents, mime_type = None, filename = None, size = None) -.. py:class:: BlobInput Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - Binary large object input data. + Binary large object data. :param filename: The original filename of the blob. :type filename: str @@ -94,30 +34,41 @@ Module Contents :param size: The size of the blob in bytes. :type size: int - .. py:attribute:: filename - :type: str + :type: str + .. py:attribute:: contents - :type: bytes + :type: bytes + .. py:attribute:: mime_type - :type: str + :type: str + .. py:attribute:: size - :type: int + :type: int + .. py:method:: from_local_file(file_path) :classmethod: - .. py:method:: from_contents(contents, filename = None, mime_type = None) :classmethod: +.. py:class:: BlobInput(filename = None, contents = None, mime_type = None, size = None) + + + Bases: :py:obj:`Blob` + + Binary large object data. + An alias for Blob, used to indicate that this is an input object. + + diff --git a/docs/_sources/autoapi/abacusai/api_class/connectors/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/connectors/index.rst.txt index afeddc05b..50fbffbc5 100644 --- a/docs/_sources/autoapi/abacusai/api_class/connectors/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/connectors/index.rst.txt @@ -1,80 +1,38 @@ -abacusai.api_class.connectors -============================= +:py:mod:`abacusai.api_class.connectors` +======================================= .. py:module:: abacusai.api_class.connectors +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.connectors._ApiClassFactory - abacusai.api_class.connectors.DatasetConfig abacusai.api_class.connectors.StreamingConnectorDatasetConfig abacusai.api_class.connectors.KafkaDatasetConfig abacusai.api_class.connectors._StreamingConnectorDatasetConfigFactory -Module Contents ---------------- - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - - - -.. py:class:: DatasetConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for dataset configs - - :param is_documentset: Whether the dataset is a document set - :type is_documentset: bool - - - .. py:attribute:: is_documentset - :type: bool .. py:class:: StreamingConnectorDatasetConfig - Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` + Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` An abstract class for dataset configs specific to streaming connectors. :param streaming_connector_type: The type of streaming connector :type streaming_connector_type: StreamingConnectorType - .. py:attribute:: streaming_connector_type - :type: abacusai.api_class.enums.StreamingConnectorType + :type: abacusai.api_class.enums.StreamingConnectorType + .. py:method:: _get_builder() :classmethod: @@ -83,39 +41,42 @@ Module Contents .. py:class:: KafkaDatasetConfig - Bases: :py:obj:`StreamingConnectorDatasetConfig` + Bases: :py:obj:`StreamingConnectorDatasetConfig` Dataset config for Kafka Streaming Connector :param topic: The kafka topic to consume :type topic: str - .. py:attribute:: topic - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _StreamingConnectorDatasetConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'streaming_connector_type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/dataset/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/dataset/index.rst.txt index 4fe0a3943..6ad0b4469 100644 --- a/docs/_sources/autoapi/abacusai/api_class/dataset/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/dataset/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.dataset -========================== +:py:mod:`abacusai.api_class.dataset` +==================================== .. py:module:: abacusai.api_class.dataset +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.dataset.ApiClass - abacusai.api_class.dataset.OcrMode abacusai.api_class.dataset.DatasetConfig abacusai.api_class.dataset.ParsingConfig abacusai.api_class.dataset.DocumentProcessingConfig @@ -18,130 +19,28 @@ Classes abacusai.api_class.dataset.IncrementalDatabaseConnectorConfig -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: OcrMode - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: DEFAULT - :value: 'DEFAULT' - - - - .. py:attribute:: LAYOUT - :value: 'LAYOUT' - - - - .. py:attribute:: SCANNED - :value: 'SCANNED' - - - - .. py:attribute:: COMPREHENSIVE - :value: 'COMPREHENSIVE' - - - - .. py:attribute:: COMPREHENSIVE_V2 - :value: 'COMPREHENSIVE_V2' - - - - .. py:attribute:: COMPREHENSIVE_TABLE_MD - :value: 'COMPREHENSIVE_TABLE_MD' - .. py:class:: DatasetConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for dataset configs :param is_documentset: Whether the dataset is a document set :type is_documentset: bool - .. py:attribute:: is_documentset - :type: bool + :type: bool + + .. py:class:: ParsingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Custom config for dataset parsing. @@ -152,23 +51,26 @@ Module Contents :param file_path_with_schema: Path to the file with schema. Defaults to None. :type file_path_with_schema: str - .. py:attribute:: escape - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: file_path_with_schema - :type: str + :type: str + + .. py:class:: DocumentProcessingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Document processing configuration. @@ -184,46 +86,54 @@ Module Contents :type remove_watermarks: bool :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. :type convert_to_markdown: bool - + :param return_links: Whether to augment the extracted text with embedded URLs in the PDF. Defaults to False. This option only takes effect when the document is a PDF. + :type return_links: bool .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool :value: False - + .. py:attribute:: ocr_mode - :type: abacusai.api_class.enums.OcrMode + :type: abacusai.api_class.enums.OcrMode + .. py:attribute:: use_full_ocr - :type: bool - :value: None - + :type: bool + .. py:attribute:: remove_header_footer - :type: bool + :type: bool :value: False - + .. py:attribute:: remove_watermarks - :type: bool + :type: bool :value: True - + .. py:attribute:: convert_to_markdown - :type: bool + :type: bool + :value: False + + + + .. py:attribute:: return_links + :type: bool :value: False + .. py:class:: DatasetDocumentProcessingConfig - Bases: :py:obj:`DocumentProcessingConfig` + Bases: :py:obj:`DocumentProcessingConfig` Document processing configuration for dataset imports. @@ -242,25 +152,25 @@ Module Contents :param page_text_column: Name of the output column which contains the extracted text for each page. If not provided, no column will be created. :type page_text_column: str - .. py:attribute:: page_text_column - :type: str - :value: None + :type: str + .. py:class:: IncrementalDatabaseConnectorConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Config information for incremental datasets from database connectors :param timestamp_column: If dataset is incremental, this is the column name of the required column in the dataset. This column must contain timestamps in descending order which are used to determine the increments of the incremental dataset. :type timestamp_column: str - .. py:attribute:: timestamp_column - :type: str + :type: str + + diff --git a/docs/_sources/autoapi/abacusai/api_class/dataset_application_connector/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/dataset_application_connector/index.rst.txt index bdbfdab5d..bb9c6a19d 100644 --- a/docs/_sources/autoapi/abacusai/api_class/dataset_application_connector/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/dataset_application_connector/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.dataset_application_connector -================================================ +:py:mod:`abacusai.api_class.dataset_application_connector` +========================================================== .. py:module:: abacusai.api_class.dataset_application_connector +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.dataset_application_connector._ApiClassFactory - abacusai.api_class.dataset_application_connector.DatasetConfig abacusai.api_class.dataset_application_connector.ApplicationConnectorDatasetConfig abacusai.api_class.dataset_application_connector.ConfluenceDatasetConfig abacusai.api_class.dataset_application_connector.GoogleAnalyticsDatasetConfig @@ -24,65 +25,22 @@ Classes abacusai.api_class.dataset_application_connector._ApplicationConnectorDatasetConfigFactory -Module Contents ---------------- - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - - - -.. py:class:: DatasetConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for dataset configs - - :param is_documentset: Whether the dataset is a document set - :type is_documentset: bool - - - .. py:attribute:: is_documentset - :type: bool .. py:class:: ApplicationConnectorDatasetConfig - Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` + Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` An abstract class for dataset configs specific to application connectors. :param application_connector_type: The type of application connector :type application_connector_type: enums.ApplicationConnectorType - .. py:attribute:: application_connector_type - :type: abacusai.api_class.enums.ApplicationConnectorType + :type: abacusai.api_class.enums.ApplicationConnectorType + .. py:method:: _get_builder() :classmethod: @@ -91,8 +49,8 @@ Module Contents .. py:class:: ConfluenceDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Confluence Application Connector :param location: The location of the pages to fetch @@ -104,30 +62,34 @@ Module Contents :param extract_bounding_boxes: Whether to extract bounding boxes from the documents :type extract_bounding_boxes: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: pull_attachments - :type: bool + :type: bool + .. py:attribute:: space_key - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: GoogleAnalyticsDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Google Analytics Application Connector @@ -138,26 +100,29 @@ Module Contents :param end_timestamp: Unix timestamp of the end of the period that will be queried :type end_timestamp: int - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: start_timestamp - :type: int + :type: int + .. py:attribute:: end_timestamp - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: GoogleDriveDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Google Drive Application Connector @@ -170,30 +135,34 @@ Module Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: JiraDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Jira Application Connector @@ -206,30 +175,34 @@ Module Contents :param include_watchers: Fetch watchers for each issue :type include_watchers: bool - .. py:attribute:: jql - :type: str + :type: str + .. py:attribute:: custom_fields - :type: list + :type: list + .. py:attribute:: include_comments - :type: bool + :type: bool + .. py:attribute:: include_watchers - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: OneDriveDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for OneDrive Application Connector @@ -242,30 +215,34 @@ Module Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: SharepointDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Sharepoint Application Connector @@ -278,48 +255,53 @@ Module Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ZendeskDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Zendesk Application Connector :param location: The regex location of the files to fetch :type location: str - .. py:attribute:: location - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: AbacusUsageMetricsDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Abacus Usage Metrics Application Connector @@ -328,46 +310,50 @@ Module Contents :param include_all_feedback: Whether to include all feedback for this deployment conversation :type include_all_feedback: bool - .. py:attribute:: include_entire_conversation_history - :type: bool + :type: bool + .. py:attribute:: include_all_feedback - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: FreshserviceDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Freshservice Application Connector - .. py:method:: __post_init__() + .. py:class:: _ApplicationConnectorDatasetConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'application_connector_type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/deployment/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/deployment/index.rst.txt index f7c4e10c5..53ba8f450 100644 --- a/docs/_sources/autoapi/abacusai/api_class/deployment/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/deployment/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.deployment -============================= +:py:mod:`abacusai.api_class.deployment` +======================================= .. py:module:: abacusai.api_class.deployment +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.deployment.ApiClass - abacusai.api_class.deployment._ApiClassFactory abacusai.api_class.deployment.PredictionArguments abacusai.api_class.deployment.OptimizationPredictionArguments abacusai.api_class.deployment.TimeseriesAnomalyPredictionArguments @@ -23,117 +24,29 @@ Classes abacusai.api_class.deployment._PredictionArgumentsFactory -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - .. py:class:: PredictionArguments - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for prediction arguments specific to problem type. - .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:method:: _get_builder() :classmethod: @@ -142,8 +55,8 @@ Module Contents .. py:class:: OptimizationPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the OPTIMIZATION problem type @@ -154,26 +67,29 @@ Module Contents :param include_all_assignments: If True, will return all assignments, including assignments with value 0. Default is False. :type include_all_assignments: bool - .. py:attribute:: forced_assignments - :type: dict + :type: dict + .. py:attribute:: solve_time_limit_seconds - :type: float + :type: float + .. py:attribute:: include_all_assignments - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TimeseriesAnomalyPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the TS_ANOMALY problem type @@ -184,26 +100,29 @@ Module Contents :param get_all_item_data: If True, anomaly detection has to be performed on all the data related to input ids :type get_all_item_data: bool - .. py:attribute:: start_timestamp - :type: str + :type: str + .. py:attribute:: end_timestamp - :type: str + :type: str + .. py:attribute:: get_all_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ChatLLMPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the CHAT_LLM problem type @@ -220,38 +139,44 @@ Module Contents :param ignore_documents: If True, will ignore any documents and search results, and only use the messages to generate a response. :type ignore_documents: bool - .. py:attribute:: llm_name - :type: str + :type: str + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: system_message - :type: str + :type: str + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: ignore_documents - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: RegressionPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the PREDICTIVE_MODELING problem type @@ -260,22 +185,24 @@ Module Contents :param explainer_type: Type of explainer to use for explanations. :type explainer_type: str - .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: ForecastingPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the FORECASTING problem type @@ -290,34 +217,39 @@ Module Contents :param get_item_data: If True, will return the data corresponding to items as well. :type get_item_data: bool - .. py:attribute:: num_predictions - :type: int + :type: int + .. py:attribute:: prediction_start - :type: str + :type: str + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:attribute:: get_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: CumulativeForecastingPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the CUMULATIVE_FORECASTING problem type @@ -332,34 +264,39 @@ Module Contents :param get_item_data: If True, will return the data corresponding to items as well. :type get_item_data: bool - .. py:attribute:: num_predictions - :type: int + :type: int + .. py:attribute:: prediction_start - :type: str + :type: str + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:attribute:: get_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NaturalLanguageSearchPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the NATURAL_LANGUAGE_SEARCH problem type @@ -376,69 +313,78 @@ Module Contents :param ignore_documents: If True, will ignore any documents and search results, and only use the messages to generate a response. :type ignore_documents: bool - .. py:attribute:: llm_name - :type: str + :type: str + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: system_message - :type: str + :type: str + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: ignore_documents - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: FeatureStorePredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the FEATURE_STORE problem type :param limit_results: If provided, will limit the number of results to the value specified. :type limit_results: int - .. py:attribute:: limit_results - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: _PredictionArgumentsFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/document_retriever/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/document_retriever/index.rst.txt index ad26e1752..88676b7a0 100644 --- a/docs/_sources/autoapi/abacusai/api_class/document_retriever/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/document_retriever/index.rst.txt @@ -1,126 +1,34 @@ -abacusai.api_class.document_retriever -===================================== +:py:mod:`abacusai.api_class.document_retriever` +=============================================== .. py:module:: abacusai.api_class.document_retriever -Attributes ----------- - -.. autoapisummary:: - - abacusai.api_class.document_retriever.DocumentRetrieverConfig - +Module Contents +--------------- Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.document_retriever.ApiClass - abacusai.api_class.document_retriever.VectorStoreTextEncoder abacusai.api_class.document_retriever.VectorStoreConfig -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: VectorStoreTextEncoder - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: E5 - :value: 'E5' - - - - .. py:attribute:: OPENAI - :value: 'OPENAI' - - - - .. py:attribute:: SENTENCE_BERT - :value: 'SENTENCE_BERT' +Attributes +~~~~~~~~~~ - .. py:attribute:: E5_SMALL - :value: 'E5_SMALL' +.. autoapisummary:: + abacusai.api_class.document_retriever.DocumentRetrieverConfig .. py:class:: VectorStoreConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Config for indexing options of a document retriever. Default values of optional arguments are heuristically selected by the Abacus.AI platform based on the underlying data. @@ -137,30 +45,38 @@ Module Contents :param prune_vectors: Transform vectors using SVD so that the average component of vectors in the corpus are removed. :type prune_vectors: bool - .. py:attribute:: chunk_size - :type: int + :type: int + .. py:attribute:: chunk_overlap_fraction - :type: float + :type: float + .. py:attribute:: text_encoder - :type: abacusai.api_class.enums.VectorStoreTextEncoder + :type: abacusai.api_class.enums.VectorStoreTextEncoder + .. py:attribute:: chunk_size_factors - :type: list + :type: list + .. py:attribute:: score_multiplier_column - :type: str + :type: str + .. py:attribute:: prune_vectors - :type: bool + :type: bool + + .. py:data:: DocumentRetrieverConfig + + diff --git a/docs/_sources/autoapi/abacusai/api_class/enums/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/enums/index.rst.txt index e41fee1d1..7e2b45b91 100644 --- a/docs/_sources/autoapi/abacusai/api_class/enums/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/enums/index.rst.txt @@ -1,11 +1,14 @@ -abacusai.api_class.enums -======================== +:py:mod:`abacusai.api_class.enums` +================================== .. py:module:: abacusai.api_class.enums +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: @@ -22,6 +25,8 @@ Classes abacusai.api_class.enums.ExplainerType abacusai.api_class.enums.SamplingMethodType abacusai.api_class.enums.MergeMode + abacusai.api_class.enums.OperatorType + abacusai.api_class.enums.MarkdownOperatorInputType abacusai.api_class.enums.FillLogic abacusai.api_class.enums.BatchSize abacusai.api_class.enums.HolidayCalendars @@ -66,27 +71,26 @@ Classes abacusai.api_class.enums.DataType abacusai.api_class.enums.AgentInterface abacusai.api_class.enums.ProjectConfigType + abacusai.api_class.enums.CPUSize + abacusai.api_class.enums.MemorySize + -Module Contents ---------------- .. py:class:: ApiEnum - Bases: :py:obj:`enum.Enum` + Bases: :py:obj:`enum.Enum` Generic enumeration. Derive from this class to define new enumerations. - .. py:method:: __eq__(other) Return self==value. - .. py:method:: __hash__() Return hash(self). @@ -95,2311 +99,2435 @@ Module Contents .. py:class:: ProblemType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AI_AGENT :value: 'ai_agent' - + .. py:attribute:: EVENT_ANOMALY :value: 'event_anomaly' - + .. py:attribute:: CLUSTERING :value: 'clustering' - + .. py:attribute:: CLUSTERING_TIMESERIES :value: 'clustering_timeseries' - + .. py:attribute:: CUMULATIVE_FORECASTING :value: 'cumulative_forecasting' - + .. py:attribute:: NAMED_ENTITY_EXTRACTION :value: 'nlp_ner' - + .. py:attribute:: NATURAL_LANGUAGE_SEARCH :value: 'nlp_search' - + .. py:attribute:: CHAT_LLM :value: 'chat_llm' - + .. py:attribute:: SENTENCE_BOUNDARY_DETECTION :value: 'nlp_sentence_boundary_detection' - + .. py:attribute:: SENTIMENT_DETECTION :value: 'nlp_sentiment' - + .. py:attribute:: DOCUMENT_CLASSIFICATION :value: 'nlp_classification' - + .. py:attribute:: DOCUMENT_SUMMARIZATION :value: 'nlp_summarization' - + .. py:attribute:: DOCUMENT_VISUALIZATION :value: 'nlp_document_visualization' - + .. py:attribute:: PERSONALIZATION :value: 'personalization' - + .. py:attribute:: PREDICTIVE_MODELING :value: 'regression' - + .. py:attribute:: FINETUNED_LLM :value: 'finetuned_llm' - + .. py:attribute:: FORECASTING :value: 'forecasting' - + .. py:attribute:: CUSTOM_TRAINED_MODEL :value: 'plug_and_play' - + .. py:attribute:: CUSTOM_ALGORITHM :value: 'trainable_plug_and_play' - + .. py:attribute:: FEATURE_STORE :value: 'feature_store' - + .. py:attribute:: IMAGE_CLASSIFICATION :value: 'vision_classification' - + .. py:attribute:: OBJECT_DETECTION :value: 'vision_object_detection' - + .. py:attribute:: IMAGE_VALUE_PREDICTION :value: 'vision_regression' - + .. py:attribute:: MODEL_MONITORING :value: 'model_monitoring' - + .. py:attribute:: LANGUAGE_DETECTION :value: 'language_detection' - + .. py:attribute:: OPTIMIZATION :value: 'optimization' - + .. py:attribute:: PRETRAINED_MODELS :value: 'pretrained' - + .. py:attribute:: THEME_ANALYSIS :value: 'theme_analysis' - + .. py:attribute:: TS_ANOMALY :value: 'ts_anomaly' + .. py:class:: RegressionObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUC :value: 'auc' - + .. py:attribute:: ACCURACY :value: 'acc' - + .. py:attribute:: LOG_LOSS :value: 'log_loss' - + .. py:attribute:: PRECISION :value: 'precision' - + .. py:attribute:: RECALL :value: 'recall' - + .. py:attribute:: F1_SCORE :value: 'fscore' - + .. py:attribute:: MAE :value: 'mae' - + .. py:attribute:: MAPE :value: 'mape' - + .. py:attribute:: WAPE :value: 'wape' - + .. py:attribute:: RMSE :value: 'rmse' - + .. py:attribute:: R_SQUARED_COEFFICIENT_OF_DETERMINATION :value: 'r^2' + .. py:class:: RegressionTreeHPOMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: PartialDependenceAnalysis - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: RegressionAugmentationStrategy - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: SMOTE :value: 'smote' - + .. py:attribute:: RESAMPLE :value: 'resample' + .. py:class:: RegressionTargetTransform - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LOG :value: 'log' - + .. py:attribute:: QUANTILE :value: 'quantile' - + .. py:attribute:: YEO_JOHNSON :value: 'yeo-johnson' - + .. py:attribute:: BOX_COX :value: 'box-cox' + .. py:class:: RegressionTypeOfSplit - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RANDOM :value: 'Random Sampling' - + .. py:attribute:: TIMESTAMP_BASED :value: 'Timestamp Based' - + .. py:attribute:: ROW_INDICATOR_BASED :value: 'Row Indicator Based' - + .. py:attribute:: STRATIFIED_RANDOM_SAMPLING :value: 'Stratified Random Sampling' + .. py:class:: RegressionTimeSplitMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: TEST_SPLIT_PERCENTAGE_BASED :value: 'Test Split Percentage Based' - + .. py:attribute:: TEST_START_TIMESTAMP_BASED :value: 'Test Start Timestamp Based' + .. py:class:: RegressionLossFunction - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HUBER :value: 'Huber' - + .. py:attribute:: MSE :value: 'Mean Squared Error' - + .. py:attribute:: MAE :value: 'Mean Absolute Error' - + .. py:attribute:: MAPE :value: 'Mean Absolute Percentage Error' - + .. py:attribute:: MSLE :value: 'Mean Squared Logarithmic Error' - + .. py:attribute:: TWEEDIE :value: 'Tweedie' - + .. py:attribute:: CROSS_ENTROPY :value: 'Cross Entropy' - + .. py:attribute:: FOCAL_CROSS_ENTROPY :value: 'Focal Cross Entropy' - + .. py:attribute:: AUTOMATIC :value: 'Automatic' - + .. py:attribute:: CUSTOM :value: 'Custom' + .. py:class:: ExplainerType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KERNEL_EXPLAINER :value: 'KERNEL_EXPLAINER' - + .. py:attribute:: LIME_EXPLAINER :value: 'LIME_EXPLAINER' - + .. py:attribute:: TREE_EXPLAINER :value: 'TREE_EXPLAINER' - + .. py:attribute:: EBM_EXPLAINER :value: 'EBM_EXPLAINER' + .. py:class:: SamplingMethodType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: N_SAMPLING :value: 'N_SAMPLING' - + .. py:attribute:: PERCENT_SAMPLING :value: 'PERCENT_SAMPLING' + .. py:class:: MergeMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LAST_N :value: 'LAST_N' - + .. py:attribute:: TIME_WINDOW :value: 'TIME_WINDOW' + -.. py:class:: FillLogic +.. py:class:: OperatorType + Bases: :py:obj:`ApiEnum` + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: UNPIVOT + :value: 'UNPIVOT' + + + + .. py:attribute:: MARKDOWN + :value: 'MARKDOWN' + + + + .. py:attribute:: CRAWLER + :value: 'CRAWLER' + + + + .. py:attribute:: EXTRACT_DOCUMENT_DATA + :value: 'EXTRACT_DOCUMENT_DATA' + + + + +.. py:class:: MarkdownOperatorInputType + + + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. + .. py:attribute:: HTML + :value: 'HTML' + + + + +.. py:class:: FillLogic + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. .. py:attribute:: AVERAGE :value: 'average' - + .. py:attribute:: MAX :value: 'max' - + .. py:attribute:: MEDIAN :value: 'median' - + .. py:attribute:: MIN :value: 'min' - + .. py:attribute:: CUSTOM :value: 'custom' - + .. py:attribute:: BACKFILL :value: 'bfill' - + .. py:attribute:: FORWARDFILL :value: 'ffill' - + .. py:attribute:: LINEAR :value: 'linear' - + .. py:attribute:: NEAREST :value: 'nearest' + .. py:class:: BatchSize - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: BATCH_8 :value: 8 - + .. py:attribute:: BATCH_16 :value: 16 - + .. py:attribute:: BATCH_32 :value: 32 - + .. py:attribute:: BATCH_64 :value: 64 - + .. py:attribute:: BATCH_128 :value: 128 - + .. py:attribute:: BATCH_256 :value: 256 - + .. py:attribute:: BATCH_384 :value: 384 - + .. py:attribute:: BATCH_512 :value: 512 - + .. py:attribute:: BATCH_740 :value: 740 - + .. py:attribute:: BATCH_1024 :value: 1024 + .. py:class:: HolidayCalendars - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AU :value: 'AU' - + .. py:attribute:: UK :value: 'UK' - + .. py:attribute:: US :value: 'US' + .. py:class:: FileFormat - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AVRO :value: 'AVRO' - + .. py:attribute:: PARQUET :value: 'PARQUET' - + .. py:attribute:: TFRECORD :value: 'TFRECORD' - + .. py:attribute:: TSV :value: 'TSV' - + .. py:attribute:: CSV :value: 'CSV' - + .. py:attribute:: ORC :value: 'ORC' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: ODS :value: 'ODS' - + .. py:attribute:: XLS :value: 'XLS' - + .. py:attribute:: GZ :value: 'GZ' - + .. py:attribute:: ZIP :value: 'ZIP' - + .. py:attribute:: TAR :value: 'TAR' - + .. py:attribute:: DOCX :value: 'DOCX' - + .. py:attribute:: PDF :value: 'PDF' - + .. py:attribute:: RAR :value: 'RAR' - + .. py:attribute:: JPEG :value: 'JPG' - + .. py:attribute:: PNG :value: 'PNG' - + .. py:attribute:: TIF :value: 'TIFF' - + .. py:attribute:: NUMBERS :value: 'NUMBERS' - + .. py:attribute:: PPTX :value: 'PPTX' - + .. py:attribute:: PPT :value: 'PPT' - + .. py:attribute:: HTML :value: 'HTML' - + .. py:attribute:: TXT :value: 'txt' + .. py:class:: ExperimentationMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: PersonalizationTrainingMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: EXPERIMENTAL :value: 'EXP' - + .. py:attribute:: PRODUCTION :value: 'PROD' + .. py:class:: PersonalizationObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NDCG :value: 'ndcg' - + .. py:attribute:: NDCG_5 :value: 'ndcg@5' - + .. py:attribute:: NDCG_10 :value: 'ndcg@10' - + .. py:attribute:: MAP :value: 'map' - + .. py:attribute:: MAP_5 :value: 'map@5' - + .. py:attribute:: MAP_10 :value: 'map@10' - + .. py:attribute:: MRR :value: 'mrr' - + .. py:attribute:: PERSONALIZATION :value: 'personalization@10' - + .. py:attribute:: COVERAGE :value: 'coverage' + .. py:class:: ForecastingObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ACCURACY :value: 'w_c_accuracy' - + .. py:attribute:: WAPE :value: 'wape' - + .. py:attribute:: MAPE :value: 'mape' - + .. py:attribute:: CMAPE :value: 'cmape' - + .. py:attribute:: RMSE :value: 'rmse' - + .. py:attribute:: CV :value: 'coefficient_of_variation' - + .. py:attribute:: BIAS :value: 'bias' - + .. py:attribute:: SRMSE :value: 'srmse' + .. py:class:: ForecastingFrequency - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HOURLY :value: '1H' - + .. py:attribute:: DAILY :value: '1D' - + .. py:attribute:: WEEKLY_SUNDAY_START :value: '1W' - + .. py:attribute:: WEEKLY_MONDAY_START :value: 'W-MON' - + .. py:attribute:: WEEKLY_SATURDAY_START :value: 'W-SAT' - + .. py:attribute:: MONTH_START :value: 'MS' - + .. py:attribute:: MONTH_END :value: '1M' - + .. py:attribute:: QUARTER_START :value: 'QS' - + .. py:attribute:: QUARTER_END :value: '1Q' - + .. py:attribute:: YEARLY :value: '1Y' + .. py:class:: ForecastingDataSplitType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'Automatic Time Based' - + .. py:attribute:: TIMESTAMP :value: 'Timestamp Based' - + .. py:attribute:: ITEM :value: 'Item Based' - + .. py:attribute:: PREDICTION_LENGTH :value: 'Force Prediction Length' + .. py:class:: ForecastingLossFunction - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: CUSTOM :value: 'Custom' - + .. py:attribute:: MEAN_ABSOLUTE_ERROR :value: 'mae' - + .. py:attribute:: NORMALIZED_MEAN_ABSOLUTE_ERROR :value: 'nmae' - + .. py:attribute:: PEAKS_MEAN_ABSOLUTE_ERROR :value: 'peaks_mae' - + .. py:attribute:: MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'stable_mape' - + .. py:attribute:: POINTWISE_ACCURACY :value: 'accuracy' - + .. py:attribute:: ROOT_MEAN_SQUARE_ERROR :value: 'rmse' - + .. py:attribute:: NORMALIZED_ROOT_MEAN_SQUARE_ERROR :value: 'nrmse' - + .. py:attribute:: ASYMMETRIC_MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'asymmetric_mape' - + .. py:attribute:: STABLE_STANDARDIZED_MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'stable_standardized_mape_with_cmape' - + .. py:attribute:: GAUSSIAN :value: 'mle_gaussian_local' - + .. py:attribute:: GAUSSIAN_FULL_COVARIANCE :value: 'mle_gaussfullcov' - + .. py:attribute:: GUASSIAN_EXPONENTIAL :value: 'mle_gaussexp' - + .. py:attribute:: MIX_GAUSSIANS :value: 'mle_gaussmix' - + .. py:attribute:: WEIBULL :value: 'mle_weibull' - + .. py:attribute:: NEGATIVE_BINOMIAL :value: 'mle_negbinom' - + .. py:attribute:: LOG_ROOT_MEAN_SQUARE_ERROR :value: 'log_rmse' + .. py:class:: ForecastingLocalScaling + Bases: :py:obj:`ApiEnum` - Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ZSCORE :value: 'zscore' - + .. py:attribute:: SLIDING_ZSCORE :value: 'sliding_zscore' - + .. py:attribute:: LAST_POINT :value: 'lastpoint' - + .. py:attribute:: MIN_MAX :value: 'minmax' - + .. py:attribute:: MIN_STD :value: 'minstd' - + .. py:attribute:: ROBUST :value: 'robust' - + .. py:attribute:: ITEM :value: 'item' + .. py:class:: ForecastingFillMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: BACK :value: 'BACK' - + .. py:attribute:: MIDDLE :value: 'MIDDLE' - + .. py:attribute:: FUTURE :value: 'FUTURE' + .. py:class:: ForecastingQuanitlesExtensionMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DIRECT :value: 'direct' - + .. py:attribute:: QUADRATIC :value: 'quadratic' - + .. py:attribute:: ANCESTRAL_SIMULATION :value: 'simulation' + .. py:class:: TimeseriesAnomalyDataSplitType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'Automatic Time Based' - + .. py:attribute:: TIMESTAMP :value: 'Fixed Timestamp Based' + .. py:class:: TimeseriesAnomalyTypeOfAnomaly - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HIGH_PEAK :value: 'high_peak' - + .. py:attribute:: LOW_PEAK :value: 'low_peak' + .. py:class:: TimeseriesAnomalyUseHeuristic - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ENABLE :value: 'enable' - + .. py:attribute:: DISABLE :value: 'disable' - + .. py:attribute:: AUTOMATIC :value: 'automatic' + .. py:class:: NERObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LOG_LOSS :value: 'log_loss' - + .. py:attribute:: AUC :value: 'auc' - + .. py:attribute:: PRECISION :value: 'precision' - + .. py:attribute:: RECALL :value: 'recall' - + .. py:attribute:: ANNOTATIONS_PRECISION :value: 'annotations_precision' - + .. py:attribute:: ANNOTATIONS_RECALL :value: 'annotations_recall' + .. py:class:: NERModelType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: PRETRAINED_BERT :value: 'pretrained_bert' - + .. py:attribute:: PRETRAINED_ROBERTA_27 :value: 'pretrained_roberta_27' - + .. py:attribute:: PRETRAINED_ROBERTA_43 :value: 'pretrained_roberta_43' - + .. py:attribute:: PRETRAINED_MULTILINGUAL :value: 'pretrained_multilingual' - + .. py:attribute:: LEARNED :value: 'learned' + .. py:class:: NLPDocumentFormat - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'auto' - + .. py:attribute:: TEXT :value: 'text' - + .. py:attribute:: DOC :value: 'doc' - + .. py:attribute:: TOKENS :value: 'tokens' + .. py:class:: SentimentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: VALENCE :value: 'valence' - + .. py:attribute:: EMOTION :value: 'emotion' + .. py:class:: ClusteringImputationMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTOMATIC :value: 'Automatic' - + .. py:attribute:: ZEROS :value: 'Zeros' - + .. py:attribute:: INTERPOLATE :value: 'Interpolate' + .. py:class:: ConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FILE :value: 'FILE' - + .. py:attribute:: DATABASE :value: 'DATABASE' - + .. py:attribute:: STREAMING :value: 'STREAMING' - + .. py:attribute:: APPLICATION :value: 'APPLICATION' + .. py:class:: ApplicationConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: GOOGLEANALYTICS :value: 'GOOGLEANALYTICS' - + .. py:attribute:: GOOGLEDRIVE :value: 'GOOGLEDRIVE' - + .. py:attribute:: GIT :value: 'GIT' - + .. py:attribute:: CONFLUENCE :value: 'CONFLUENCE' - + .. py:attribute:: JIRA :value: 'JIRA' - + .. py:attribute:: ONEDRIVE :value: 'ONEDRIVE' - + .. py:attribute:: ZENDESK :value: 'ZENDESK' - + .. py:attribute:: SLACK :value: 'SLACK' - + .. py:attribute:: SHAREPOINT :value: 'SHAREPOINT' - + .. py:attribute:: TEAMS :value: 'TEAMS' - + .. py:attribute:: ABACUSUSAGEMETRICS :value: 'ABACUSUSAGEMETRICS' - + .. py:attribute:: MICROSOFTAUTH :value: 'MICROSOFTAUTH' - + .. py:attribute:: FRESHSERVICE :value: 'FRESHSERVICE' - + .. py:attribute:: ZENDESKSUNSHINEMESSAGING :value: 'ZENDESKSUNSHINEMESSAGING' + .. py:class:: StreamingConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KAFKA :value: 'KAFKA' + .. py:class:: PythonFunctionArgumentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FEATURE_GROUP :value: 'FEATURE_GROUP' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: DATASET_ID :value: 'DATASET_ID' - + .. py:attribute:: MODEL_ID :value: 'MODEL_ID' - + .. py:attribute:: FEATURE_GROUP_ID :value: 'FEATURE_GROUP_ID' - + .. py:attribute:: MONITOR_ID :value: 'MONITOR_ID' - + .. py:attribute:: BATCH_PREDICTION_ID :value: 'BATCH_PREDICTION_ID' - + .. py:attribute:: DEPLOYMENT_ID :value: 'DEPLOYMENT_ID' + .. py:class:: PythonFunctionOutputArgumentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NTEGER :value: 'INTEGER' - + .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: DATASET_ID :value: 'DATASET_ID' - + .. py:attribute:: MODEL_ID :value: 'MODEL_ID' - + .. py:attribute:: FEATURE_GROUP_ID :value: 'FEATURE_GROUP_ID' - + .. py:attribute:: MONITOR_ID :value: 'MONITOR_ID' - + .. py:attribute:: BATCH_PREDICTION_ID :value: 'BATCH_PREDICTION_ID' - + .. py:attribute:: DEPLOYMENT_ID :value: 'DEPLOYMENT_ID' - + .. py:attribute:: ANY :value: 'ANY' + .. py:class:: VectorStoreTextEncoder - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: E5 :value: 'E5' - + .. py:attribute:: OPENAI :value: 'OPENAI' - + .. py:attribute:: SENTENCE_BERT :value: 'SENTENCE_BERT' - + .. py:attribute:: E5_SMALL :value: 'E5_SMALL' + + + .. py:attribute:: CODE_BERT + :value: 'CODE_BERT' + + .. py:class:: LLMName - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: OPENAI_GPT4 :value: 'OPENAI_GPT4' - + .. py:attribute:: OPENAI_GPT4_32K :value: 'OPENAI_GPT4_32K' - + .. py:attribute:: OPENAI_GPT4_128K :value: 'OPENAI_GPT4_128K' - + .. py:attribute:: OPENAI_GPT4_128K_LATEST :value: 'OPENAI_GPT4_128K_LATEST' - + .. py:attribute:: OPENAI_GPT4_VISION :value: 'OPENAI_GPT4_VISION' - + .. py:attribute:: OPENAI_GPT4O :value: 'OPENAI_GPT4O' - + .. py:attribute:: OPENAI_GPT3_5 :value: 'OPENAI_GPT3_5' - + .. py:attribute:: OPENAI_GPT3_5_TEXT :value: 'OPENAI_GPT3_5_TEXT' - + .. py:attribute:: LLAMA3_LARGE_CHAT :value: 'LLAMA3_LARGE_CHAT' - + .. py:attribute:: GROQ_LLAMA3_LARGE_CHAT :value: 'GROQ_LLAMA3_LARGE_CHAT' - + .. py:attribute:: CLAUDE_V2_1 :value: 'CLAUDE_V2_1' - + .. py:attribute:: CLAUDE_V3_OPUS :value: 'CLAUDE_V3_OPUS' - + .. py:attribute:: CLAUDE_V3_SONNET :value: 'CLAUDE_V3_SONNET' - + .. py:attribute:: CLAUDE_V3_HAIKU :value: 'CLAUDE_V3_HAIKU' - + .. py:attribute:: ABACUS_GIRAFFE :value: 'ABACUS_GIRAFFE' - + .. py:attribute:: ABACUS_GIRAFFE_LARGE :value: 'ABACUS_GIRAFFE_LARGE' - + .. py:attribute:: LLAMA2_CHAT :value: 'LLAMA2_CHAT' - + .. py:attribute:: PALM :value: 'PALM' - + .. py:attribute:: PALM_TEXT :value: 'PALM_TEXT' - + .. py:attribute:: GEMINI_PRO :value: 'GEMINI_PRO' - + .. py:attribute:: GEMINI_1_5_PRO :value: 'GEMINI_1_5_PRO' - + .. py:attribute:: MIXTRAL_CHAT :value: 'MIXTRAL_CHAT' - + .. py:attribute:: MISTRAL_MEDIUM :value: 'MISTRAL_MEDIUM' - + .. py:attribute:: ABACUS_SMAUG3 :value: 'ABACUS_SMAUG3' + .. py:class:: MonitorAlertType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ACCURACY_BELOW_THRESHOLD :value: 'AccuracyBelowThreshold' - + .. py:attribute:: FEATURE_DRIFT :value: 'FeatureDrift' - + .. py:attribute:: DATA_INTEGRITY_VIOLATIONS :value: 'DataIntegrityViolations' - + .. py:attribute:: BIAS_VIOLATIONS :value: 'BiasViolations' - + .. py:attribute:: HISTORY_LENGTH_DRIFT :value: 'HistoryLengthDrift' - + .. py:attribute:: TARGET_DRIFT :value: 'TargetDrift' - + .. py:attribute:: PREDICTION_COUNT :value: 'PredictionCount' + .. py:class:: FeatureDriftType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KL :value: 'kl' - + .. py:attribute:: KS :value: 'ks' - + .. py:attribute:: WS :value: 'ws' - + .. py:attribute:: JS :value: 'js' - + .. py:attribute:: PSI :value: 'psi' - + .. py:attribute:: CHI_SQUARE :value: 'chi_square' - + .. py:attribute:: CSI :value: 'csi' + .. py:class:: DataIntegrityViolationType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NULL_VIOLATIONS :value: 'null_violations' - + .. py:attribute:: RANGE_VIOLATIONS :value: 'range_violations' - + .. py:attribute:: CATEGORICAL_RANGE_VIOLATION :value: 'categorical_range_violations' - + .. py:attribute:: TOTAL_VIOLATIONS :value: 'total_violations' + .. py:class:: BiasType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEMOGRAPHIC_PARITY :value: 'demographic_parity' - + .. py:attribute:: EQUAL_OPPORTUNITY :value: 'equal_opportunity' - + .. py:attribute:: GROUP_BENEFIT_EQUALITY :value: 'group_benefit' - + .. py:attribute:: TOTAL :value: 'total' + .. py:class:: AlertActionType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: EMAIL :value: 'Email' + .. py:class:: PythonFunctionType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FEATURE_GROUP :value: 'FEATURE_GROUP' - + .. py:attribute:: PLOTLY_FIG :value: 'PLOTLY_FIG' - + .. py:attribute:: STEP_FUNCTION :value: 'STEP_FUNCTION' + .. py:class:: EvalArtifactType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FORECASTING_ACCURACY :value: 'bar_chart' - + .. py:attribute:: FORECASTING_VOLUME :value: 'bar_chart_volume' - + .. py:attribute:: FORECASTING_HISTORY_LENGTH_ACCURACY :value: 'bar_chart_accuracy_by_history' + .. py:class:: FieldDescriptorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: DATETIME :value: 'DATETIME' - + .. py:attribute:: DATE :value: 'DATE' + .. py:class:: WorkflowNodeInputType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: USER_INPUT :value: 'USER_INPUT' - + .. py:attribute:: WORKFLOW_VARIABLE :value: 'WORKFLOW_VARIABLE' + .. py:class:: WorkflowNodeOutputType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ATTACHMENT :value: 'ATTACHMENT' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: DICT :value: 'DICT' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: STRING :value: 'STRING' + .. py:class:: OcrMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEFAULT :value: 'DEFAULT' - + .. py:attribute:: LAYOUT :value: 'LAYOUT' - + .. py:attribute:: SCANNED :value: 'SCANNED' - + .. py:attribute:: COMPREHENSIVE :value: 'COMPREHENSIVE' - + .. py:attribute:: COMPREHENSIVE_V2 :value: 'COMPREHENSIVE_V2' - + .. py:attribute:: COMPREHENSIVE_TABLE_MD :value: 'COMPREHENSIVE_TABLE_MD' + + + .. py:attribute:: TESSERACT_FAST + :value: 'TESSERACT_FAST' + + .. py:class:: StdDevThresholdType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ABSOLUTE :value: 'ABSOLUTE' - + .. py:attribute:: PERCENTILE :value: 'PERCENTILE' - + .. py:attribute:: STDDEV :value: 'STDDEV' + .. py:class:: DataType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: INTEGER :value: 'integer' - + .. py:attribute:: FLOAT :value: 'float' - + .. py:attribute:: STRING :value: 'string' - + .. py:attribute:: DATE :value: 'date' - + .. py:attribute:: DATETIME :value: 'datetime' - + .. py:attribute:: BOOLEAN :value: 'boolean' - + .. py:attribute:: LIST :value: 'list' - + .. py:attribute:: STRUCT :value: 'struct' - + .. py:attribute:: NULL :value: 'null' + + + .. py:attribute:: BINARY + :value: 'binary' + + .. py:class:: AgentInterface - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEFAULT :value: 'DEFAULT' - + .. py:attribute:: CHAT :value: 'CHAT' + .. py:class:: ProjectConfigType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: CONSTRAINTS :value: 'CONSTRAINTS' + + + .. py:attribute:: CHAT_FEEDBACK + :value: 'CHAT_FEEDBACK' + .. py:attribute:: REVIEW_MODE :value: 'REVIEW_MODE' + + + +.. py:class:: CPUSize + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: SMALL + :value: 'small' + + + + .. py:attribute:: MEDIUM + :value: 'medium' + + + + .. py:attribute:: LARGE + :value: 'large' + + + + +.. py:class:: MemorySize + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: SMALL + :value: 16 + + + + .. py:attribute:: MEDIUM + :value: 32 + + + + .. py:attribute:: LARGE + :value: 64 + + + + .. py:attribute:: XLARGE + :value: 128 + + + + .. py:method:: from_value(value) + :classmethod: + diff --git a/docs/_sources/autoapi/abacusai/api_class/feature_group/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/feature_group/index.rst.txt index 7f1f98125..b628beef2 100644 --- a/docs/_sources/autoapi/abacusai/api_class/feature_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/feature_group/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.feature_group -================================ +:py:mod:`abacusai.api_class.feature_group` +========================================== .. py:module:: abacusai.api_class.feature_group +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.feature_group.ApiClass - abacusai.api_class.feature_group._ApiClassFactory abacusai.api_class.feature_group.SamplingConfig abacusai.api_class.feature_group.NSamplingConfig abacusai.api_class.feature_group.PercentSamplingConfig @@ -19,287 +20,419 @@ Classes abacusai.api_class.feature_group.LastNMergeConfig abacusai.api_class.feature_group.TimeWindowMergeConfig abacusai.api_class.feature_group._MergeConfigFactory + abacusai.api_class.feature_group.OperatorConfig + abacusai.api_class.feature_group.UnpivotConfig + abacusai.api_class.feature_group.MarkdownConfig + abacusai.api_class.feature_group.CrawlerTransformConfig + abacusai.api_class.feature_group.ExtractDocumentDataConfig + abacusai.api_class.feature_group._OperatorConfigFactory -Module Contents ---------------- -.. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` +.. py:class:: SamplingConfig - Helper class that provides a standard way to create an ABC using - inheritance. + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + An abstract class for the sampling config of a feature group - .. py:attribute:: _upper_snake_case_keys - :type: bool + .. py:attribute:: sampling_method + :type: abacusai.api_class.enums.SamplingMethodType + - .. py:attribute:: _support_kwargs - :type: bool + .. py:method:: _get_builder() + :classmethod: .. py:method:: __post_init__() - .. py:method:: _get_builder() - :classmethod: - +.. py:class:: NSamplingConfig - .. py:method:: __str__() - Return str(self). + Bases: :py:obj:`SamplingConfig` + The number of distinct values of the key columns to include in the sample, or number of rows if key columns not specified. + :param sample_count: The number of rows to include in the sample + :type sample_count: int + :param key_columns: The feature(s) to use as the key(s) when sampling + :type key_columns: List[str] - .. py:method:: _repr_html_() + .. py:attribute:: sample_count + :type: int + - .. py:method:: __getitem__(item) + .. py:attribute:: key_columns + :type: List[str] + - .. py:method:: __setitem__(item, value) + .. py:method:: __post_init__() - .. py:method:: _unset_item(item) +.. py:class:: PercentSamplingConfig - .. py:method:: get(item, default = None) + Bases: :py:obj:`SamplingConfig` - .. py:method:: pop(item, default = NotImplemented) + The fraction of distinct values of the feature group to include in the sample. + :param sample_percent: The percentage of the rows to sample + :type sample_percent: float + :param key_columns: The feature(s) to use as the key(s) when sampling + :type key_columns: List[str] - .. py:method:: to_dict() + .. py:attribute:: sample_percent + :type: float - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. + + .. py:attribute:: key_columns + :type: List[str] + - .. py:method:: from_dict(input_dict) - :classmethod: + .. py:method:: __post_init__() -.. py:class:: _ApiClassFactory +.. py:class:: _SamplingConfigFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - - .. py:attribute:: config_abstract_class - :value: None - - - .. py:attribute:: config_class_key - :value: None + :value: 'sampling_method' + + .. py:attribute:: config_abstract_class - .. py:attribute:: config_class_map + + .. py:attribute:: config_class_map - .. py:method:: from_dict(config) - :classmethod: + +.. py:class:: MergeConfig -.. py:class:: SamplingConfig Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + An abstract class for the merge config of a feature group - An abstract class for the sampling config of a feature group - - - .. py:attribute:: sampling_method - :type: abacusai.api_class.enums.SamplingMethodType + .. py:attribute:: merge_mode + :type: abacusai.api_class.enums.MergeMode + .. py:method:: _get_builder() :classmethod: - .. py:method:: __post_init__() -.. py:class:: NSamplingConfig - Bases: :py:obj:`SamplingConfig` +.. py:class:: LastNMergeConfig - The number of distinct values of the key columns to include in the sample, or number of rows if key columns not specified. + Bases: :py:obj:`MergeConfig` - :param sampling_method: N_SAMPLING - :type sampling_method: SamplingMethodType - :param sample_count: The number of rows to include in the sample - :type sample_count: int - :param key_columns: The feature(s) to use as the key(s) when sampling - :type key_columns: List[str] + Merge LAST N chunks/versions of an incremental dataset. + :param num_versions: The number of versions to merge. num_versions == 0 means merge all versions. + :type num_versions: int + :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. + :type include_version_timestamp_column: bool - .. py:attribute:: sample_count - :type: int + .. py:attribute:: num_versions + :type: int + - .. py:attribute:: key_columns - :type: List[str] + .. py:attribute:: include_version_timestamp_column + :type: bool + .. py:method:: __post_init__() -.. py:class:: PercentSamplingConfig - Bases: :py:obj:`SamplingConfig` +.. py:class:: TimeWindowMergeConfig - The fraction of distinct values of the feature group to include in the sample. + Bases: :py:obj:`MergeConfig` - :param sampling_method: PERCENT_SAMPLING - :type sampling_method: SamplingMethodType - :param sample_percent: The percentage of the rows to sample - :type sample_percent: float - :param key_columns: The feature(s) to use as the key(s) when sampling - :type key_columns: List[str] + Merge rows within a given timewindow of the most recent timestamp + :param feature_name: Time based column to index on + :type feature_name: str + :param time_window_size_ms: Range of merged rows will be [MAX_TIME - time_window_size_ms, MAX_TIME] + :type time_window_size_ms: int + :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. + :type include_version_timestamp_column: bool - .. py:attribute:: sample_percent - :type: float + .. py:attribute:: feature_name + :type: str + - .. py:attribute:: key_columns - :type: List[str] + .. py:attribute:: time_window_size_ms + :type: int + + + + .. py:attribute:: include_version_timestamp_column + :type: bool + .. py:method:: __post_init__() -.. py:class:: _SamplingConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` +.. py:class:: _MergeConfigFactory + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_class_key - :value: 'sampling_method' - + :value: 'merge_mode' + .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_map + -.. py:class:: MergeConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` +.. py:class:: OperatorConfig - An abstract class for the merge config of a feature group + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Configuration for a template Feature Group Operation - .. py:attribute:: merge_mode - :type: abacusai.api_class.enums.MergeMode + .. py:attribute:: operator_type + :type: abacusai.api_class.enums.OperatorType + .. py:method:: _get_builder() :classmethod: + .. py:method:: __post_init__() + + + +.. py:class:: UnpivotConfig + + + Bases: :py:obj:`OperatorConfig` + + Unpivot Columns in a FeatureGroup. + + :param columns: Which columns to unpivot. + :type columns: List[str] + :param index_column: Name of new column containing the unpivoted column names as its values + :type index_column: str + :param value_column: Name of new column containing the row values that were unpivoted. + :type value_column: str + :param exclude: If True, the unpivoted columns are all the columns EXCEPT the ones in the columns argument. Default is False. + :type exclude: bool + + .. py:attribute:: columns + :type: List[str] + + + + .. py:attribute:: index_column + :type: str + + + + .. py:attribute:: value_column + :type: str + + + + .. py:attribute:: exclude + :type: bool + + .. py:method:: __post_init__() -.. py:class:: LastNMergeConfig - Bases: :py:obj:`MergeConfig` +.. py:class:: MarkdownConfig - Merge LAST N chunks/versions of an incremental dataset. + Bases: :py:obj:`OperatorConfig` - :param merge_mode: LAST_N - :type merge_mode: MergeMode - :param num_versions: The number of versions to merge. num_versions == 0 means merge all versions. - :type num_versions: int - :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. - :type include_version_timestamp_column: bool + Transform a input column to a markdown column. + :param input_column: Name of input column to transform. + :type input_column: str + :param output_column: Name of output column to store transformed data. + :type output_column: str + :param input_column_type: Type of input column to transform. + :type input_column_type: MarkdownOperatorInputType - .. py:attribute:: num_versions - :type: int + .. py:attribute:: input_column + :type: str + - .. py:attribute:: include_version_timestamp_column - :type: bool + .. py:attribute:: output_column + :type: str + + + .. py:attribute:: input_column_type + :type: abacusai.api_class.enums.MarkdownOperatorInputType + + .. py:method:: __post_init__() -.. py:class:: TimeWindowMergeConfig - Bases: :py:obj:`MergeConfig` +.. py:class:: CrawlerTransformConfig - Merge rows within a given timewindow of the most recent timestamp + Bases: :py:obj:`OperatorConfig` - :param merge_mode: TIME_WINDOW - :type merge_mode: MergeMode - :param feature_name: Time based column to index on - :type feature_name: str - :param time_window_size_ms: Range of merged rows will be [MAX_TIME - time_window_size_ms, MAX_TIME] - :type time_window_size_ms: int - :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. - :type include_version_timestamp_column: bool + Transform a input column of urls to html text + :param input_column: Name of input column to transform. + :type input_column: str + :param output_column: Name of output column to store transformed data. + :type output_column: str + :param depth_column: Increasing depth explores more links, capturing more content + :type depth_column: str + :param disable_host_restriction: If True, will not restrict crawling to the same host. + :type disable_host_restriction: bool + :param honour_website_rules: If True, will respect robots.txt rules. + :type honour_website_rules: bool + :param user_agent: If provided, will use this user agent instead of randomly selecting one. + :type user_agent: str - .. py:attribute:: feature_name - :type: str + .. py:attribute:: input_column + :type: str + - .. py:attribute:: time_window_size_ms - :type: int + .. py:attribute:: output_column + :type: str + - .. py:attribute:: include_version_timestamp_column - :type: bool + .. py:attribute:: depth_column + :type: str + + + + .. py:attribute:: input_column_type + :type: str + + + + .. py:attribute:: crawl_depth + :type: int + + + + .. py:attribute:: disable_host_restriction + :type: bool + + + + .. py:attribute:: honour_website_rules + :type: bool + + + + .. py:attribute:: user_agent + :type: str + .. py:method:: __post_init__() -.. py:class:: _MergeConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` +.. py:class:: ExtractDocumentDataConfig - Helper class that provides a standard way to create an ABC using - inheritance. + Bases: :py:obj:`OperatorConfig` + Extracts data from documents. - .. py:attribute:: config_class_key - :value: 'merge_mode' + :param doc_id_column: Name of input document ID column. + :type doc_id_column: str + :param document_column: Name of the input document column which contains the page infos. This column will be transformed to include the document processing config in the output feature group. + :type document_column: str + :param document_processing_config: Document processing configuration. + :type document_processing_config: DocumentProcessingConfig + .. py:attribute:: doc_id_column + :type: str + + + .. py:attribute:: document_column + :type: str + + + + .. py:attribute:: document_processing_config + :type: abacusai.api_class.dataset.DocumentProcessingConfig + + + + .. py:method:: __post_init__() + + + +.. py:class:: _OperatorConfigFactory + + + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + + A class to select and return the the correct type of Operator Config based on a serialized OperatorConfig instance. .. py:attribute:: config_abstract_class + + + .. py:attribute:: config_class_key + :value: 'operator_type' + + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/index.rst.txt index 1950359e5..d720f2ceb 100644 --- a/docs/_sources/autoapi/abacusai/api_class/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/index.rst.txt @@ -1,45 +1,40 @@ -abacusai.api_class -================== +:py:mod:`abacusai.api_class` +============================ .. py:module:: abacusai.api_class Submodules ---------- - .. toctree:: + :titlesonly: :maxdepth: 1 - /autoapi/abacusai/api_class/abstract/index - /autoapi/abacusai/api_class/ai_agents/index - /autoapi/abacusai/api_class/ai_chat/index - /autoapi/abacusai/api_class/batch_prediction/index - /autoapi/abacusai/api_class/blob_input/index - /autoapi/abacusai/api_class/connectors/index - /autoapi/abacusai/api_class/dataset/index - /autoapi/abacusai/api_class/dataset_application_connector/index - /autoapi/abacusai/api_class/deployment/index - /autoapi/abacusai/api_class/document_retriever/index - /autoapi/abacusai/api_class/enums/index - /autoapi/abacusai/api_class/feature_group/index - /autoapi/abacusai/api_class/model/index - /autoapi/abacusai/api_class/monitor/index - /autoapi/abacusai/api_class/monitor_alert/index - /autoapi/abacusai/api_class/project/index - /autoapi/abacusai/api_class/python_functions/index - /autoapi/abacusai/api_class/refresh/index - - -Attributes ----------- - -.. autoapisummary:: + abstract/index.rst + ai_agents/index.rst + ai_chat/index.rst + batch_prediction/index.rst + blob_input/index.rst + connectors/index.rst + dataset/index.rst + dataset_application_connector/index.rst + deployment/index.rst + document_retriever/index.rst + enums/index.rst + feature_group/index.rst + model/index.rst + monitor/index.rst + monitor_alert/index.rst + project/index.rst + python_functions/index.rst + refresh/index.rst - abacusai.api_class.DocumentRetrieverConfig +Package Contents +---------------- Classes -------- +~~~~~~~ .. autoapisummary:: @@ -68,7 +63,13 @@ Classes abacusai.api_class.TrainablePlugAndPlayBatchPredictionArgs abacusai.api_class._BatchPredictionArgsFactory abacusai.api_class.ApiClass + abacusai.api_class.Blob abacusai.api_class.BlobInput + abacusai.api_class._ApiClassFactory + abacusai.api_class.DatasetConfig + abacusai.api_class.StreamingConnectorDatasetConfig + abacusai.api_class.KafkaDatasetConfig + abacusai.api_class._StreamingConnectorDatasetConfigFactory abacusai.api_class.ApiClass abacusai.api_class.OcrMode abacusai.api_class.DatasetConfig @@ -117,6 +118,8 @@ Classes abacusai.api_class.ExplainerType abacusai.api_class.SamplingMethodType abacusai.api_class.MergeMode + abacusai.api_class.OperatorType + abacusai.api_class.MarkdownOperatorInputType abacusai.api_class.FillLogic abacusai.api_class.BatchSize abacusai.api_class.HolidayCalendars @@ -161,8 +164,11 @@ Classes abacusai.api_class.DataType abacusai.api_class.AgentInterface abacusai.api_class.ProjectConfigType + abacusai.api_class.CPUSize + abacusai.api_class.MemorySize abacusai.api_class.ApiClass abacusai.api_class._ApiClassFactory + abacusai.api_class.DocumentProcessingConfig abacusai.api_class.SamplingConfig abacusai.api_class.NSamplingConfig abacusai.api_class.PercentSamplingConfig @@ -171,6 +177,12 @@ Classes abacusai.api_class.LastNMergeConfig abacusai.api_class.TimeWindowMergeConfig abacusai.api_class._MergeConfigFactory + abacusai.api_class.OperatorConfig + abacusai.api_class.UnpivotConfig + abacusai.api_class.MarkdownConfig + abacusai.api_class.CrawlerTransformConfig + abacusai.api_class.ExtractDocumentDataConfig + abacusai.api_class._OperatorConfigFactory abacusai.api_class.ApiClass abacusai.api_class._ApiClassFactory abacusai.api_class.TrainingConfig @@ -240,33 +252,41 @@ Classes abacusai.api_class._FeatureGroupExportConfigFactory + Functions ---------- +~~~~~~~~~ .. autoapisummary:: abacusai.api_class.get_clean_function_source_code -Package Contents ----------------- + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + abacusai.api_class.DocumentRetrieverConfig + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -275,13 +295,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -307,7 +325,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -315,10 +332,11 @@ Package Contents .. py:function:: get_clean_function_source_code(func) + .. py:class:: FieldDescriptor - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Configs for vector store indexing. @@ -331,43 +349,48 @@ Package Contents :param type: The type of this field. If not provided, the default type is STRING. :type type: FieldDescriptorType - .. py:attribute:: field - :type: str + :type: str + .. py:attribute:: description - :type: str + :type: str + .. py:attribute:: example_extraction - :type: Union[str, int, bool, float, list, dict] + :type: Union[str, int, bool, float, list, dict] + .. py:attribute:: type - :type: abacusai.api_class.enums.FieldDescriptorType + :type: abacusai.api_class.enums.FieldDescriptorType + + .. py:class:: WorkflowNodeInputSchema - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A react-jsonschema-form conformant schema for workflow node input. - :param json_schema: The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, File Upload. Not supported - Nested elements, arrays and other complex types. + :param json_schema: The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, file upload. Not supported - Nested elements, arrays and other complex types. :type json_schema: dict :param ui_schema: The ui schema for the input conformant to react-jsonschema-form specification. :type ui_schema: dict - .. py:attribute:: json_schema - :type: dict + :type: dict + .. py:attribute:: ui_schema - :type: dict + :type: dict + .. py:method:: to_dict() @@ -376,7 +399,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(schema) :classmethod: @@ -384,18 +406,18 @@ Package Contents .. py:class:: WorkflowNodeOutputSchema - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A react-jsonschema-form schema for a workflow node output. :param json_schema: The json schema for the output conformant to react-jsonschema-form specification. :type json_schema: dict - .. py:attribute:: json_schema - :type: dict + :type: dict + .. py:method:: to_dict() @@ -404,7 +426,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(schema) :classmethod: @@ -412,8 +433,8 @@ Package Contents .. py:class:: WorkflowNodeInputMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A mapping of input to a workflow node. @@ -429,22 +450,25 @@ Package Contents :param is_required: Whether the input is required. Defaults to True :type is_required: bool - .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: variable_type - :type: abacusai.api_class.enums.WorkflowNodeInputType + :type: abacusai.api_class.enums.WorkflowNodeInputType + .. py:attribute:: variable_source - :type: str + :type: str + .. py:attribute:: is_required - :type: bool + :type: bool + .. py:method:: to_dict() @@ -453,7 +477,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(mapping) :classmethod: @@ -461,8 +484,8 @@ Package Contents .. py:class:: WorkflowNodeOutputMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A mapping of output to a workflow node. @@ -471,14 +494,15 @@ Package Contents :param variable_type: The type of the output. :type variable_type: WorkflowNodeOutputType - .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: variable_type - :type: abacusai.api_class.enums.WorkflowNodeOutputType + :type: abacusai.api_class.enums.WorkflowNodeOutputType + .. py:method:: to_dict() @@ -487,7 +511,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(mapping) :classmethod: @@ -495,8 +518,8 @@ Package Contents .. py:class:: WorkflowGraphNode(name, input_mappings, output_mappings, function = None, function_name = None, source_code = None, input_schema = None, output_schema = None, package_requirements = None) - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A node in an Agent workflow graph. @@ -515,7 +538,6 @@ Package Contents :param package_requirements: List of package requirements for the node. :type package_requirements: list - .. py:method:: to_dict() Standardizes converting an ApiClass to dictionary. @@ -523,7 +545,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(node) :classmethod: @@ -531,8 +552,8 @@ Package Contents .. py:class:: WorkflowGraphEdge - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An edge in an Agent workflow graph. @@ -543,26 +564,29 @@ Package Contents :param details: Additional details about the edge. :type details: dict - .. py:attribute:: source - :type: str + :type: str + .. py:attribute:: target - :type: str + :type: str + .. py:attribute:: details - :type: dict + :type: dict + .. py:method:: to_nx_edge() + .. py:class:: WorkflowGraph - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. @@ -571,14 +595,15 @@ Package Contents :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. :type edges: List[WorkflowGraphEdge] - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] + :type: List[WorkflowGraphNode] + .. py:attribute:: edges - :type: List[WorkflowGraphEdge] + :type: List[WorkflowGraphEdge] + .. py:method:: to_dict() @@ -587,7 +612,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(graph) :classmethod: @@ -595,20 +619,21 @@ Package Contents .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -617,13 +642,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -649,7 +672,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -657,8 +679,8 @@ Package Contents .. py:class:: HotkeyPrompt - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for a Data Science Co-Pilot Hotkey @@ -667,39 +689,44 @@ Package Contents :param title: A short, descriptive title for the prompt. If not provided, one will be automatically generated. :type title: str - .. py:attribute:: prompt - :type: str + :type: str + .. py:attribute:: title - :type: str + :type: str + .. py:attribute:: disable_problem_type_context - :type: bool + :type: bool + .. py:attribute:: ignore_history - :type: bool + :type: bool + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -708,13 +735,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -740,7 +765,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -748,25 +772,23 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -775,23 +797,25 @@ Package Contents .. py:class:: BatchPredictionArgs - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for Batch Prediction args specific to problem type. - .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:method:: _get_builder() :classmethod: @@ -800,8 +824,8 @@ Package Contents .. py:class:: ForecastingBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the FORECASTING problem type @@ -822,64 +846,73 @@ Package Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: predictions_start_date - :type: str + :type: str + .. py:attribute:: use_prediction_offset - :type: bool + :type: bool + .. py:attribute:: start_date_offset - :type: int + :type: int + .. py:attribute:: forecasting_horizon - :type: int + :type: int + .. py:attribute:: item_attributes_to_include_in_the_result - :type: list + :type: list + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NamedEntityExtractionBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the NAMED_ENTITY_EXTRACTION problem type :param for_eval: If True, the test fold which was created during training and used for metrics calculation will be used as input data. These predictions are hence, used for model evaluation. :type for_eval: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: PersonalizationBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PERSONALIZATION problem type @@ -892,30 +925,34 @@ Package Contents :param score_field: If specified, relative item scores will be returned using a field with this name :type score_field: str - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: number_of_items - :type: int + :type: int + .. py:attribute:: item_attributes_to_include_in_the_result - :type: list + :type: list + .. py:attribute:: score_field - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: PredictiveModelingBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PREDICTIVE_MODELING problem type @@ -944,62 +981,74 @@ Package Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: abacusai.api_class.enums.ExplainerType + :type: abacusai.api_class.enums.ExplainerType + .. py:attribute:: number_of_samples_to_use_for_explainer - :type: int + :type: int + .. py:attribute:: include_multi_class_explanations - :type: bool + :type: bool + .. py:attribute:: features_considered_constant_for_explanations - :type: str + :type: str + .. py:attribute:: importance_of_records_in_nested_columns - :type: str + :type: str + .. py:attribute:: explanation_filter_lower_bound - :type: float + :type: float + .. py:attribute:: explanation_filter_upper_bound - :type: float + :type: float + .. py:attribute:: explanation_filter_label - :type: str + :type: str + .. py:attribute:: output_columns - :type: list + :type: list + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: PretrainedModelsBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PRETRAINED_MODELS problem type @@ -1010,26 +1059,29 @@ Package Contents :param channel_id_to_label_map: JSON string for the map from channel ids to their labels. :type channel_id_to_label_map: str - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: files_output_location_prefix - :type: str + :type: str + .. py:attribute:: channel_id_to_label_map - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: SentenceBoundaryDetectionBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the SENTENCE_BOUNDARY_DETECTION problem type @@ -1038,22 +1090,24 @@ Package Contents :param explode_output: Explode data so there is one sentence per row. :type explode_output: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: explode_output - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ThemeAnalysisBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the THEME_ANALYSIS problem type @@ -1066,48 +1120,53 @@ Package Contents :param analysis_days: How many days to analyze. :type analysis_days: int - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: analysis_frequency - :type: str + :type: str + .. py:attribute:: start_date - :type: str + :type: str + .. py:attribute:: analysis_days - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: ChatLLMBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the ChatLLM problem type :param for_eval: If True, the test fold which was created during training and used for metrics calculation will be used as input data. These predictions are hence, used for model evaluation. :type for_eval: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TrainablePlugAndPlayBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the TrainablePlugAndPlay problem type @@ -1116,54 +1175,59 @@ Package Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _BatchPredictionArgsFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -1172,13 +1236,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -1204,18 +1266,17 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: -.. py:class:: BlobInput +.. py:class:: Blob(contents, mime_type = None, filename = None, size = None) - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - Binary large object input data. + Binary large object data. :param filename: The original filename of the blob. :type filename: str @@ -1226,49 +1287,163 @@ Package Contents :param size: The size of the blob in bytes. :type size: int - .. py:attribute:: filename - :type: str + :type: str + .. py:attribute:: contents - :type: bytes + :type: bytes + .. py:attribute:: mime_type - :type: str + :type: str + .. py:attribute:: size - :type: int + :type: int + .. py:method:: from_local_file(file_path) :classmethod: - .. py:method:: from_contents(contents, filename = None, mime_type = None) :classmethod: -.. py:class:: ApiClass +.. py:class:: BlobInput(filename = None, contents = None, mime_type = None, size = None) + + + Bases: :py:obj:`Blob` + + Binary large object data. + An alias for Blob, used to indicate that this is an input object. + + +.. py:class:: _ApiClassFactory + Bases: :py:obj:`abc.ABC` + Helper class that provides a standard way to create an ABC using + inheritance. + + .. py:attribute:: config_abstract_class + + + + .. py:attribute:: config_class_key + + + + .. py:attribute:: config_class_map + + + + .. py:method:: from_dict(config) + :classmethod: + + + +.. py:class:: DatasetConfig + + + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + + An abstract class for dataset configs + + :param is_documentset: Whether the dataset is a document set + :type is_documentset: bool + + .. py:attribute:: is_documentset + :type: bool + + + + +.. py:class:: StreamingConnectorDatasetConfig + + + Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` + + An abstract class for dataset configs specific to streaming connectors. + + :param streaming_connector_type: The type of streaming connector + :type streaming_connector_type: StreamingConnectorType + + .. py:attribute:: streaming_connector_type + :type: abacusai.api_class.enums.StreamingConnectorType + + + + .. py:method:: _get_builder() + :classmethod: + + + +.. py:class:: KafkaDatasetConfig + + + Bases: :py:obj:`StreamingConnectorDatasetConfig` + + Dataset config for Kafka Streaming Connector + + :param topic: The kafka topic to consume + :type topic: str + + .. py:attribute:: topic + :type: str + + + + .. py:method:: __post_init__() + + + +.. py:class:: _StreamingConnectorDatasetConfigFactory + + + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. + .. py:attribute:: config_abstract_class + + + + .. py:attribute:: config_class_key + :value: 'streaming_connector_type' + + + + .. py:attribute:: config_class_map + + + + +.. py:class:: ApiClass + + + Bases: :py:obj:`abc.ABC` + + Helper class that provides a standard way to create an ABC using + inheritance. .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -1277,13 +1452,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -1309,7 +1482,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -1317,63 +1489,69 @@ Package Contents .. py:class:: OcrMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEFAULT :value: 'DEFAULT' - + .. py:attribute:: LAYOUT :value: 'LAYOUT' - + .. py:attribute:: SCANNED :value: 'SCANNED' - + .. py:attribute:: COMPREHENSIVE :value: 'COMPREHENSIVE' - + .. py:attribute:: COMPREHENSIVE_V2 :value: 'COMPREHENSIVE_V2' - + .. py:attribute:: COMPREHENSIVE_TABLE_MD :value: 'COMPREHENSIVE_TABLE_MD' + + + .. py:attribute:: TESSERACT_FAST + :value: 'TESSERACT_FAST' + + .. py:class:: DatasetConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for dataset configs :param is_documentset: Whether the dataset is a document set :type is_documentset: bool - .. py:attribute:: is_documentset - :type: bool + :type: bool + + .. py:class:: ParsingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Custom config for dataset parsing. @@ -1384,23 +1562,26 @@ Package Contents :param file_path_with_schema: Path to the file with schema. Defaults to None. :type file_path_with_schema: str - .. py:attribute:: escape - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: file_path_with_schema - :type: str + :type: str + + .. py:class:: DocumentProcessingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Document processing configuration. @@ -1416,46 +1597,54 @@ Package Contents :type remove_watermarks: bool :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. :type convert_to_markdown: bool - + :param return_links: Whether to augment the extracted text with embedded URLs in the PDF. Defaults to False. This option only takes effect when the document is a PDF. + :type return_links: bool .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool :value: False - + .. py:attribute:: ocr_mode - :type: abacusai.api_class.enums.OcrMode + :type: abacusai.api_class.enums.OcrMode + .. py:attribute:: use_full_ocr - :type: bool - :value: None - + :type: bool + .. py:attribute:: remove_header_footer - :type: bool + :type: bool :value: False - + .. py:attribute:: remove_watermarks - :type: bool + :type: bool :value: True - + .. py:attribute:: convert_to_markdown - :type: bool + :type: bool :value: False + + + .. py:attribute:: return_links + :type: bool + :value: False + + .. py:class:: DatasetDocumentProcessingConfig - Bases: :py:obj:`DocumentProcessingConfig` + Bases: :py:obj:`DocumentProcessingConfig` Document processing configuration for dataset imports. @@ -1474,49 +1663,47 @@ Package Contents :param page_text_column: Name of the output column which contains the extracted text for each page. If not provided, no column will be created. :type page_text_column: str - .. py:attribute:: page_text_column - :type: str - :value: None + :type: str + .. py:class:: IncrementalDatabaseConnectorConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Config information for incremental datasets from database connectors :param timestamp_column: If dataset is incremental, this is the column name of the required column in the dataset. This column must contain timestamps in descending order which are used to determine the increments of the incremental dataset. :type timestamp_column: str - .. py:attribute:: timestamp_column - :type: str + :type: str + + .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -1525,33 +1712,34 @@ Package Contents .. py:class:: DatasetConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for dataset configs :param is_documentset: Whether the dataset is a document set :type is_documentset: bool - .. py:attribute:: is_documentset - :type: bool + :type: bool + + .. py:class:: ApplicationConnectorDatasetConfig - Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` + Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` An abstract class for dataset configs specific to application connectors. :param application_connector_type: The type of application connector :type application_connector_type: enums.ApplicationConnectorType - .. py:attribute:: application_connector_type - :type: abacusai.api_class.enums.ApplicationConnectorType + :type: abacusai.api_class.enums.ApplicationConnectorType + .. py:method:: _get_builder() :classmethod: @@ -1560,8 +1748,8 @@ Package Contents .. py:class:: ConfluenceDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Confluence Application Connector :param location: The location of the pages to fetch @@ -1573,30 +1761,34 @@ Package Contents :param extract_bounding_boxes: Whether to extract bounding boxes from the documents :type extract_bounding_boxes: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: pull_attachments - :type: bool + :type: bool + .. py:attribute:: space_key - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: GoogleAnalyticsDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Google Analytics Application Connector @@ -1607,26 +1799,29 @@ Package Contents :param end_timestamp: Unix timestamp of the end of the period that will be queried :type end_timestamp: int - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: start_timestamp - :type: int + :type: int + .. py:attribute:: end_timestamp - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: GoogleDriveDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Google Drive Application Connector @@ -1639,30 +1834,34 @@ Package Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: JiraDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Jira Application Connector @@ -1675,30 +1874,34 @@ Package Contents :param include_watchers: Fetch watchers for each issue :type include_watchers: bool - .. py:attribute:: jql - :type: str + :type: str + .. py:attribute:: custom_fields - :type: list + :type: list + .. py:attribute:: include_comments - :type: bool + :type: bool + .. py:attribute:: include_watchers - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: OneDriveDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for OneDrive Application Connector @@ -1711,30 +1914,34 @@ Package Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: SharepointDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Sharepoint Application Connector @@ -1747,48 +1954,53 @@ Package Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ZendeskDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Zendesk Application Connector :param location: The regex location of the files to fetch :type location: str - .. py:attribute:: location - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: AbacusUsageMetricsDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Abacus Usage Metrics Application Connector @@ -1797,65 +2009,70 @@ Package Contents :param include_all_feedback: Whether to include all feedback for this deployment conversation :type include_all_feedback: bool - .. py:attribute:: include_entire_conversation_history - :type: bool + :type: bool + .. py:attribute:: include_all_feedback - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: FreshserviceDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Freshservice Application Connector - .. py:method:: __post_init__() + .. py:class:: _ApplicationConnectorDatasetConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'application_connector_type' - + .. py:attribute:: config_class_map + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -1864,13 +2081,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -1896,7 +2111,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -1904,25 +2118,23 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -1931,23 +2143,25 @@ Package Contents .. py:class:: PredictionArguments - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for prediction arguments specific to problem type. - .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:method:: _get_builder() :classmethod: @@ -1956,8 +2170,8 @@ Package Contents .. py:class:: OptimizationPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the OPTIMIZATION problem type @@ -1968,26 +2182,29 @@ Package Contents :param include_all_assignments: If True, will return all assignments, including assignments with value 0. Default is False. :type include_all_assignments: bool - .. py:attribute:: forced_assignments - :type: dict + :type: dict + .. py:attribute:: solve_time_limit_seconds - :type: float + :type: float + .. py:attribute:: include_all_assignments - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TimeseriesAnomalyPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the TS_ANOMALY problem type @@ -1998,26 +2215,29 @@ Package Contents :param get_all_item_data: If True, anomaly detection has to be performed on all the data related to input ids :type get_all_item_data: bool - .. py:attribute:: start_timestamp - :type: str + :type: str + .. py:attribute:: end_timestamp - :type: str + :type: str + .. py:attribute:: get_all_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ChatLLMPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the CHAT_LLM problem type @@ -2034,38 +2254,44 @@ Package Contents :param ignore_documents: If True, will ignore any documents and search results, and only use the messages to generate a response. :type ignore_documents: bool - .. py:attribute:: llm_name - :type: str + :type: str + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: system_message - :type: str + :type: str + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: ignore_documents - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: RegressionPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the PREDICTIVE_MODELING problem type @@ -2074,22 +2300,24 @@ Package Contents :param explainer_type: Type of explainer to use for explanations. :type explainer_type: str - .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: ForecastingPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the FORECASTING problem type @@ -2104,34 +2332,39 @@ Package Contents :param get_item_data: If True, will return the data corresponding to items as well. :type get_item_data: bool - .. py:attribute:: num_predictions - :type: int + :type: int + .. py:attribute:: prediction_start - :type: str + :type: str + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:attribute:: get_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: CumulativeForecastingPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the CUMULATIVE_FORECASTING problem type @@ -2146,34 +2379,39 @@ Package Contents :param get_item_data: If True, will return the data corresponding to items as well. :type get_item_data: bool - .. py:attribute:: num_predictions - :type: int + :type: int + .. py:attribute:: prediction_start - :type: str + :type: str + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:attribute:: get_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NaturalLanguageSearchPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the NATURAL_LANGUAGE_SEARCH problem type @@ -2190,88 +2428,98 @@ Package Contents :param ignore_documents: If True, will ignore any documents and search results, and only use the messages to generate a response. :type ignore_documents: bool - .. py:attribute:: llm_name - :type: str + :type: str + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: system_message - :type: str + :type: str + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: ignore_documents - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: FeatureStorePredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the FEATURE_STORE problem type :param limit_results: If provided, will limit the number of results to the value specified. :type limit_results: int - .. py:attribute:: limit_results - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: _PredictionArgumentsFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -2280,13 +2528,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -2312,7 +2558,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -2320,38 +2565,43 @@ Package Contents .. py:class:: VectorStoreTextEncoder - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: E5 :value: 'E5' - + .. py:attribute:: OPENAI :value: 'OPENAI' - + .. py:attribute:: SENTENCE_BERT :value: 'SENTENCE_BERT' - + .. py:attribute:: E5_SMALL :value: 'E5_SMALL' + + + .. py:attribute:: CODE_BERT + :value: 'CODE_BERT' + + .. py:class:: VectorStoreConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Config for indexing options of a document retriever. Default values of optional arguments are heuristically selected by the Abacus.AI platform based on the underlying data. @@ -2368,49 +2618,55 @@ Package Contents :param prune_vectors: Transform vectors using SVD so that the average component of vectors in the corpus are removed. :type prune_vectors: bool - .. py:attribute:: chunk_size - :type: int + :type: int + .. py:attribute:: chunk_overlap_fraction - :type: float + :type: float + .. py:attribute:: text_encoder - :type: abacusai.api_class.enums.VectorStoreTextEncoder + :type: abacusai.api_class.enums.VectorStoreTextEncoder + .. py:attribute:: chunk_size_factors - :type: list + :type: list + .. py:attribute:: score_multiplier_column - :type: str + :type: str + .. py:attribute:: prune_vectors - :type: bool + :type: bool + + .. py:data:: DocumentRetrieverConfig + + .. py:class:: ApiEnum - Bases: :py:obj:`enum.Enum` + Bases: :py:obj:`enum.Enum` Generic enumeration. Derive from this class to define new enumerations. - .. py:method:: __eq__(other) Return self==value. - .. py:method:: __hash__() Return hash(self). @@ -2419,2330 +2675,2455 @@ Package Contents .. py:class:: ProblemType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AI_AGENT :value: 'ai_agent' - + .. py:attribute:: EVENT_ANOMALY :value: 'event_anomaly' - + .. py:attribute:: CLUSTERING :value: 'clustering' - + .. py:attribute:: CLUSTERING_TIMESERIES :value: 'clustering_timeseries' - + .. py:attribute:: CUMULATIVE_FORECASTING :value: 'cumulative_forecasting' - + .. py:attribute:: NAMED_ENTITY_EXTRACTION :value: 'nlp_ner' - + .. py:attribute:: NATURAL_LANGUAGE_SEARCH :value: 'nlp_search' - + .. py:attribute:: CHAT_LLM :value: 'chat_llm' - + .. py:attribute:: SENTENCE_BOUNDARY_DETECTION :value: 'nlp_sentence_boundary_detection' - + .. py:attribute:: SENTIMENT_DETECTION :value: 'nlp_sentiment' - + .. py:attribute:: DOCUMENT_CLASSIFICATION :value: 'nlp_classification' - + .. py:attribute:: DOCUMENT_SUMMARIZATION :value: 'nlp_summarization' - + .. py:attribute:: DOCUMENT_VISUALIZATION :value: 'nlp_document_visualization' - + .. py:attribute:: PERSONALIZATION :value: 'personalization' - + .. py:attribute:: PREDICTIVE_MODELING :value: 'regression' - + .. py:attribute:: FINETUNED_LLM :value: 'finetuned_llm' - + .. py:attribute:: FORECASTING :value: 'forecasting' - + .. py:attribute:: CUSTOM_TRAINED_MODEL :value: 'plug_and_play' - + .. py:attribute:: CUSTOM_ALGORITHM :value: 'trainable_plug_and_play' - + .. py:attribute:: FEATURE_STORE :value: 'feature_store' - + .. py:attribute:: IMAGE_CLASSIFICATION :value: 'vision_classification' - + .. py:attribute:: OBJECT_DETECTION :value: 'vision_object_detection' - + .. py:attribute:: IMAGE_VALUE_PREDICTION :value: 'vision_regression' - + .. py:attribute:: MODEL_MONITORING :value: 'model_monitoring' - + .. py:attribute:: LANGUAGE_DETECTION :value: 'language_detection' - + .. py:attribute:: OPTIMIZATION :value: 'optimization' - + .. py:attribute:: PRETRAINED_MODELS :value: 'pretrained' - + .. py:attribute:: THEME_ANALYSIS :value: 'theme_analysis' - + .. py:attribute:: TS_ANOMALY :value: 'ts_anomaly' + .. py:class:: RegressionObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUC :value: 'auc' - + .. py:attribute:: ACCURACY :value: 'acc' - + .. py:attribute:: LOG_LOSS :value: 'log_loss' - + .. py:attribute:: PRECISION :value: 'precision' - + .. py:attribute:: RECALL :value: 'recall' - + .. py:attribute:: F1_SCORE :value: 'fscore' - + .. py:attribute:: MAE :value: 'mae' - + .. py:attribute:: MAPE :value: 'mape' - + .. py:attribute:: WAPE :value: 'wape' - + .. py:attribute:: RMSE :value: 'rmse' - + .. py:attribute:: R_SQUARED_COEFFICIENT_OF_DETERMINATION :value: 'r^2' + .. py:class:: RegressionTreeHPOMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: PartialDependenceAnalysis - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: RegressionAugmentationStrategy - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: SMOTE :value: 'smote' - + .. py:attribute:: RESAMPLE :value: 'resample' + .. py:class:: RegressionTargetTransform - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LOG :value: 'log' - + .. py:attribute:: QUANTILE :value: 'quantile' - + .. py:attribute:: YEO_JOHNSON :value: 'yeo-johnson' - + .. py:attribute:: BOX_COX :value: 'box-cox' + .. py:class:: RegressionTypeOfSplit - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RANDOM :value: 'Random Sampling' - + .. py:attribute:: TIMESTAMP_BASED :value: 'Timestamp Based' - + .. py:attribute:: ROW_INDICATOR_BASED :value: 'Row Indicator Based' - + .. py:attribute:: STRATIFIED_RANDOM_SAMPLING :value: 'Stratified Random Sampling' + .. py:class:: RegressionTimeSplitMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: TEST_SPLIT_PERCENTAGE_BASED :value: 'Test Split Percentage Based' - + .. py:attribute:: TEST_START_TIMESTAMP_BASED :value: 'Test Start Timestamp Based' + .. py:class:: RegressionLossFunction - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HUBER :value: 'Huber' - + .. py:attribute:: MSE :value: 'Mean Squared Error' - + .. py:attribute:: MAE :value: 'Mean Absolute Error' - + .. py:attribute:: MAPE :value: 'Mean Absolute Percentage Error' - + .. py:attribute:: MSLE :value: 'Mean Squared Logarithmic Error' - + .. py:attribute:: TWEEDIE :value: 'Tweedie' - + .. py:attribute:: CROSS_ENTROPY :value: 'Cross Entropy' - + .. py:attribute:: FOCAL_CROSS_ENTROPY :value: 'Focal Cross Entropy' - + .. py:attribute:: AUTOMATIC :value: 'Automatic' - + .. py:attribute:: CUSTOM :value: 'Custom' + .. py:class:: ExplainerType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KERNEL_EXPLAINER :value: 'KERNEL_EXPLAINER' - + .. py:attribute:: LIME_EXPLAINER :value: 'LIME_EXPLAINER' - + .. py:attribute:: TREE_EXPLAINER :value: 'TREE_EXPLAINER' - + .. py:attribute:: EBM_EXPLAINER :value: 'EBM_EXPLAINER' + .. py:class:: SamplingMethodType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: N_SAMPLING :value: 'N_SAMPLING' - + .. py:attribute:: PERCENT_SAMPLING :value: 'PERCENT_SAMPLING' + .. py:class:: MergeMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LAST_N :value: 'LAST_N' - + .. py:attribute:: TIME_WINDOW :value: 'TIME_WINDOW' + -.. py:class:: FillLogic +.. py:class:: OperatorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. + .. py:attribute:: UNPIVOT + :value: 'UNPIVOT' - .. py:attribute:: AVERAGE - :value: 'average' - + + .. py:attribute:: MARKDOWN + :value: 'MARKDOWN' - .. py:attribute:: MAX - :value: 'max' + + .. py:attribute:: CRAWLER + :value: 'CRAWLER' + - .. py:attribute:: MEDIAN - :value: 'median' + .. py:attribute:: EXTRACT_DOCUMENT_DATA + :value: 'EXTRACT_DOCUMENT_DATA' + - .. py:attribute:: MIN - :value: 'min' +.. py:class:: MarkdownOperatorInputType + Bases: :py:obj:`ApiEnum` - .. py:attribute:: CUSTOM - :value: 'custom' + Generic enumeration. + Derive from this class to define new enumerations. + .. py:attribute:: HTML + :value: 'HTML' - .. py:attribute:: BACKFILL - :value: 'bfill' + +.. py:class:: FillLogic - .. py:attribute:: FORWARDFILL - :value: 'ffill' + Bases: :py:obj:`ApiEnum` + Generic enumeration. - .. py:attribute:: LINEAR - :value: 'linear' + Derive from this class to define new enumerations. + .. py:attribute:: AVERAGE + :value: 'average' + + + + .. py:attribute:: MAX + :value: 'max' + + + + .. py:attribute:: MEDIAN + :value: 'median' + + + + .. py:attribute:: MIN + :value: 'min' + + + + .. py:attribute:: CUSTOM + :value: 'custom' + + + + .. py:attribute:: BACKFILL + :value: 'bfill' + + + + .. py:attribute:: FORWARDFILL + :value: 'ffill' + + + .. py:attribute:: LINEAR + :value: 'linear' + + .. py:attribute:: NEAREST :value: 'nearest' + .. py:class:: BatchSize - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: BATCH_8 :value: 8 - + .. py:attribute:: BATCH_16 :value: 16 - + .. py:attribute:: BATCH_32 :value: 32 - + .. py:attribute:: BATCH_64 :value: 64 - + .. py:attribute:: BATCH_128 :value: 128 - + .. py:attribute:: BATCH_256 :value: 256 - + .. py:attribute:: BATCH_384 :value: 384 - + .. py:attribute:: BATCH_512 :value: 512 - + .. py:attribute:: BATCH_740 :value: 740 - + .. py:attribute:: BATCH_1024 :value: 1024 + .. py:class:: HolidayCalendars - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AU :value: 'AU' - + .. py:attribute:: UK :value: 'UK' - + .. py:attribute:: US :value: 'US' + .. py:class:: FileFormat - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AVRO :value: 'AVRO' - + .. py:attribute:: PARQUET :value: 'PARQUET' - + .. py:attribute:: TFRECORD :value: 'TFRECORD' - + .. py:attribute:: TSV :value: 'TSV' - + .. py:attribute:: CSV :value: 'CSV' - + .. py:attribute:: ORC :value: 'ORC' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: ODS :value: 'ODS' - + .. py:attribute:: XLS :value: 'XLS' - + .. py:attribute:: GZ :value: 'GZ' - + .. py:attribute:: ZIP :value: 'ZIP' - + .. py:attribute:: TAR :value: 'TAR' - + .. py:attribute:: DOCX :value: 'DOCX' - + .. py:attribute:: PDF :value: 'PDF' - + .. py:attribute:: RAR :value: 'RAR' - + .. py:attribute:: JPEG :value: 'JPG' - + .. py:attribute:: PNG :value: 'PNG' - + .. py:attribute:: TIF :value: 'TIFF' - + .. py:attribute:: NUMBERS :value: 'NUMBERS' - + .. py:attribute:: PPTX :value: 'PPTX' - + .. py:attribute:: PPT :value: 'PPT' - + .. py:attribute:: HTML :value: 'HTML' - + .. py:attribute:: TXT :value: 'txt' + .. py:class:: ExperimentationMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: PersonalizationTrainingMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: EXPERIMENTAL :value: 'EXP' - + .. py:attribute:: PRODUCTION :value: 'PROD' + .. py:class:: PersonalizationObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NDCG :value: 'ndcg' - + .. py:attribute:: NDCG_5 :value: 'ndcg@5' - + .. py:attribute:: NDCG_10 :value: 'ndcg@10' - + .. py:attribute:: MAP :value: 'map' - + .. py:attribute:: MAP_5 :value: 'map@5' - + .. py:attribute:: MAP_10 :value: 'map@10' - + .. py:attribute:: MRR :value: 'mrr' - + .. py:attribute:: PERSONALIZATION :value: 'personalization@10' - + .. py:attribute:: COVERAGE :value: 'coverage' + .. py:class:: ForecastingObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ACCURACY :value: 'w_c_accuracy' - + .. py:attribute:: WAPE :value: 'wape' - + .. py:attribute:: MAPE :value: 'mape' - + .. py:attribute:: CMAPE :value: 'cmape' - + .. py:attribute:: RMSE :value: 'rmse' - + .. py:attribute:: CV :value: 'coefficient_of_variation' - + .. py:attribute:: BIAS :value: 'bias' - + .. py:attribute:: SRMSE :value: 'srmse' + .. py:class:: ForecastingFrequency - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HOURLY :value: '1H' - + .. py:attribute:: DAILY :value: '1D' - + .. py:attribute:: WEEKLY_SUNDAY_START :value: '1W' - + .. py:attribute:: WEEKLY_MONDAY_START :value: 'W-MON' - + .. py:attribute:: WEEKLY_SATURDAY_START :value: 'W-SAT' - + .. py:attribute:: MONTH_START :value: 'MS' - + .. py:attribute:: MONTH_END :value: '1M' - + .. py:attribute:: QUARTER_START :value: 'QS' - + .. py:attribute:: QUARTER_END :value: '1Q' - + .. py:attribute:: YEARLY :value: '1Y' + .. py:class:: ForecastingDataSplitType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'Automatic Time Based' - + .. py:attribute:: TIMESTAMP :value: 'Timestamp Based' - + .. py:attribute:: ITEM :value: 'Item Based' - + .. py:attribute:: PREDICTION_LENGTH :value: 'Force Prediction Length' + .. py:class:: ForecastingLossFunction - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: CUSTOM :value: 'Custom' - + .. py:attribute:: MEAN_ABSOLUTE_ERROR :value: 'mae' - + .. py:attribute:: NORMALIZED_MEAN_ABSOLUTE_ERROR :value: 'nmae' - + .. py:attribute:: PEAKS_MEAN_ABSOLUTE_ERROR :value: 'peaks_mae' - + .. py:attribute:: MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'stable_mape' - + .. py:attribute:: POINTWISE_ACCURACY :value: 'accuracy' - + .. py:attribute:: ROOT_MEAN_SQUARE_ERROR :value: 'rmse' - + .. py:attribute:: NORMALIZED_ROOT_MEAN_SQUARE_ERROR :value: 'nrmse' - + .. py:attribute:: ASYMMETRIC_MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'asymmetric_mape' - + .. py:attribute:: STABLE_STANDARDIZED_MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'stable_standardized_mape_with_cmape' - + .. py:attribute:: GAUSSIAN :value: 'mle_gaussian_local' - + .. py:attribute:: GAUSSIAN_FULL_COVARIANCE :value: 'mle_gaussfullcov' - + .. py:attribute:: GUASSIAN_EXPONENTIAL :value: 'mle_gaussexp' - + .. py:attribute:: MIX_GAUSSIANS :value: 'mle_gaussmix' - + .. py:attribute:: WEIBULL :value: 'mle_weibull' - + .. py:attribute:: NEGATIVE_BINOMIAL :value: 'mle_negbinom' - + .. py:attribute:: LOG_ROOT_MEAN_SQUARE_ERROR :value: 'log_rmse' + .. py:class:: ForecastingLocalScaling - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ZSCORE :value: 'zscore' - + .. py:attribute:: SLIDING_ZSCORE :value: 'sliding_zscore' - + .. py:attribute:: LAST_POINT :value: 'lastpoint' - + .. py:attribute:: MIN_MAX :value: 'minmax' - + .. py:attribute:: MIN_STD :value: 'minstd' - + .. py:attribute:: ROBUST :value: 'robust' - + .. py:attribute:: ITEM :value: 'item' + .. py:class:: ForecastingFillMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: BACK :value: 'BACK' - + .. py:attribute:: MIDDLE :value: 'MIDDLE' - + .. py:attribute:: FUTURE :value: 'FUTURE' + .. py:class:: ForecastingQuanitlesExtensionMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DIRECT :value: 'direct' - + .. py:attribute:: QUADRATIC :value: 'quadratic' - + .. py:attribute:: ANCESTRAL_SIMULATION :value: 'simulation' + .. py:class:: TimeseriesAnomalyDataSplitType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'Automatic Time Based' - + .. py:attribute:: TIMESTAMP :value: 'Fixed Timestamp Based' + .. py:class:: TimeseriesAnomalyTypeOfAnomaly - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HIGH_PEAK :value: 'high_peak' - + .. py:attribute:: LOW_PEAK :value: 'low_peak' + .. py:class:: TimeseriesAnomalyUseHeuristic - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ENABLE :value: 'enable' - + .. py:attribute:: DISABLE :value: 'disable' - + .. py:attribute:: AUTOMATIC :value: 'automatic' + .. py:class:: NERObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LOG_LOSS :value: 'log_loss' - + .. py:attribute:: AUC :value: 'auc' - + .. py:attribute:: PRECISION :value: 'precision' - + .. py:attribute:: RECALL :value: 'recall' - + .. py:attribute:: ANNOTATIONS_PRECISION :value: 'annotations_precision' - + .. py:attribute:: ANNOTATIONS_RECALL :value: 'annotations_recall' + .. py:class:: NERModelType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: PRETRAINED_BERT :value: 'pretrained_bert' - + .. py:attribute:: PRETRAINED_ROBERTA_27 :value: 'pretrained_roberta_27' - + .. py:attribute:: PRETRAINED_ROBERTA_43 :value: 'pretrained_roberta_43' - + .. py:attribute:: PRETRAINED_MULTILINGUAL :value: 'pretrained_multilingual' - + .. py:attribute:: LEARNED :value: 'learned' + .. py:class:: NLPDocumentFormat - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'auto' - + .. py:attribute:: TEXT :value: 'text' - + .. py:attribute:: DOC :value: 'doc' - + .. py:attribute:: TOKENS :value: 'tokens' + .. py:class:: SentimentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: VALENCE :value: 'valence' - + .. py:attribute:: EMOTION :value: 'emotion' + .. py:class:: ClusteringImputationMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTOMATIC :value: 'Automatic' - + .. py:attribute:: ZEROS :value: 'Zeros' - + .. py:attribute:: INTERPOLATE :value: 'Interpolate' + .. py:class:: ConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FILE :value: 'FILE' - + .. py:attribute:: DATABASE :value: 'DATABASE' - + .. py:attribute:: STREAMING :value: 'STREAMING' - + .. py:attribute:: APPLICATION :value: 'APPLICATION' + .. py:class:: ApplicationConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: GOOGLEANALYTICS :value: 'GOOGLEANALYTICS' - + .. py:attribute:: GOOGLEDRIVE :value: 'GOOGLEDRIVE' - + .. py:attribute:: GIT :value: 'GIT' - + .. py:attribute:: CONFLUENCE :value: 'CONFLUENCE' - + .. py:attribute:: JIRA :value: 'JIRA' - + .. py:attribute:: ONEDRIVE :value: 'ONEDRIVE' - + .. py:attribute:: ZENDESK :value: 'ZENDESK' - + .. py:attribute:: SLACK :value: 'SLACK' - + .. py:attribute:: SHAREPOINT :value: 'SHAREPOINT' - + .. py:attribute:: TEAMS :value: 'TEAMS' - + .. py:attribute:: ABACUSUSAGEMETRICS :value: 'ABACUSUSAGEMETRICS' - + .. py:attribute:: MICROSOFTAUTH :value: 'MICROSOFTAUTH' - + .. py:attribute:: FRESHSERVICE :value: 'FRESHSERVICE' - + .. py:attribute:: ZENDESKSUNSHINEMESSAGING :value: 'ZENDESKSUNSHINEMESSAGING' + .. py:class:: StreamingConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KAFKA :value: 'KAFKA' + .. py:class:: PythonFunctionArgumentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FEATURE_GROUP :value: 'FEATURE_GROUP' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: DATASET_ID :value: 'DATASET_ID' - + .. py:attribute:: MODEL_ID :value: 'MODEL_ID' - + .. py:attribute:: FEATURE_GROUP_ID :value: 'FEATURE_GROUP_ID' - + .. py:attribute:: MONITOR_ID :value: 'MONITOR_ID' - + .. py:attribute:: BATCH_PREDICTION_ID :value: 'BATCH_PREDICTION_ID' - + .. py:attribute:: DEPLOYMENT_ID :value: 'DEPLOYMENT_ID' + .. py:class:: PythonFunctionOutputArgumentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NTEGER :value: 'INTEGER' - + .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: DATASET_ID :value: 'DATASET_ID' - + .. py:attribute:: MODEL_ID :value: 'MODEL_ID' - + .. py:attribute:: FEATURE_GROUP_ID :value: 'FEATURE_GROUP_ID' - + .. py:attribute:: MONITOR_ID :value: 'MONITOR_ID' - + .. py:attribute:: BATCH_PREDICTION_ID :value: 'BATCH_PREDICTION_ID' - + .. py:attribute:: DEPLOYMENT_ID :value: 'DEPLOYMENT_ID' - + .. py:attribute:: ANY :value: 'ANY' + .. py:class:: VectorStoreTextEncoder - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: E5 :value: 'E5' - + .. py:attribute:: OPENAI :value: 'OPENAI' - + .. py:attribute:: SENTENCE_BERT :value: 'SENTENCE_BERT' - + .. py:attribute:: E5_SMALL :value: 'E5_SMALL' + + + .. py:attribute:: CODE_BERT + :value: 'CODE_BERT' + + .. py:class:: LLMName - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: OPENAI_GPT4 :value: 'OPENAI_GPT4' - + .. py:attribute:: OPENAI_GPT4_32K :value: 'OPENAI_GPT4_32K' - + .. py:attribute:: OPENAI_GPT4_128K :value: 'OPENAI_GPT4_128K' - + .. py:attribute:: OPENAI_GPT4_128K_LATEST :value: 'OPENAI_GPT4_128K_LATEST' - + .. py:attribute:: OPENAI_GPT4_VISION :value: 'OPENAI_GPT4_VISION' - + .. py:attribute:: OPENAI_GPT4O :value: 'OPENAI_GPT4O' - + .. py:attribute:: OPENAI_GPT3_5 :value: 'OPENAI_GPT3_5' - + .. py:attribute:: OPENAI_GPT3_5_TEXT :value: 'OPENAI_GPT3_5_TEXT' - + .. py:attribute:: LLAMA3_LARGE_CHAT :value: 'LLAMA3_LARGE_CHAT' - + .. py:attribute:: GROQ_LLAMA3_LARGE_CHAT :value: 'GROQ_LLAMA3_LARGE_CHAT' - + .. py:attribute:: CLAUDE_V2_1 :value: 'CLAUDE_V2_1' - + .. py:attribute:: CLAUDE_V3_OPUS :value: 'CLAUDE_V3_OPUS' - + .. py:attribute:: CLAUDE_V3_SONNET :value: 'CLAUDE_V3_SONNET' - + .. py:attribute:: CLAUDE_V3_HAIKU :value: 'CLAUDE_V3_HAIKU' - + .. py:attribute:: ABACUS_GIRAFFE :value: 'ABACUS_GIRAFFE' - + .. py:attribute:: ABACUS_GIRAFFE_LARGE :value: 'ABACUS_GIRAFFE_LARGE' - + .. py:attribute:: LLAMA2_CHAT :value: 'LLAMA2_CHAT' - + .. py:attribute:: PALM :value: 'PALM' - + .. py:attribute:: PALM_TEXT :value: 'PALM_TEXT' - + .. py:attribute:: GEMINI_PRO :value: 'GEMINI_PRO' - + .. py:attribute:: GEMINI_1_5_PRO :value: 'GEMINI_1_5_PRO' - + .. py:attribute:: MIXTRAL_CHAT :value: 'MIXTRAL_CHAT' - + .. py:attribute:: MISTRAL_MEDIUM :value: 'MISTRAL_MEDIUM' - + .. py:attribute:: ABACUS_SMAUG3 :value: 'ABACUS_SMAUG3' + .. py:class:: MonitorAlertType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ACCURACY_BELOW_THRESHOLD :value: 'AccuracyBelowThreshold' - + .. py:attribute:: FEATURE_DRIFT :value: 'FeatureDrift' - + .. py:attribute:: DATA_INTEGRITY_VIOLATIONS :value: 'DataIntegrityViolations' - + .. py:attribute:: BIAS_VIOLATIONS :value: 'BiasViolations' - + .. py:attribute:: HISTORY_LENGTH_DRIFT :value: 'HistoryLengthDrift' - + .. py:attribute:: TARGET_DRIFT :value: 'TargetDrift' - + .. py:attribute:: PREDICTION_COUNT :value: 'PredictionCount' + .. py:class:: FeatureDriftType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KL :value: 'kl' - + .. py:attribute:: KS :value: 'ks' - + .. py:attribute:: WS :value: 'ws' - + .. py:attribute:: JS :value: 'js' - + .. py:attribute:: PSI :value: 'psi' - + .. py:attribute:: CHI_SQUARE :value: 'chi_square' - + .. py:attribute:: CSI :value: 'csi' + .. py:class:: DataIntegrityViolationType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NULL_VIOLATIONS :value: 'null_violations' - + .. py:attribute:: RANGE_VIOLATIONS :value: 'range_violations' - + .. py:attribute:: CATEGORICAL_RANGE_VIOLATION :value: 'categorical_range_violations' - + .. py:attribute:: TOTAL_VIOLATIONS :value: 'total_violations' + .. py:class:: BiasType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEMOGRAPHIC_PARITY :value: 'demographic_parity' - + .. py:attribute:: EQUAL_OPPORTUNITY :value: 'equal_opportunity' - + .. py:attribute:: GROUP_BENEFIT_EQUALITY :value: 'group_benefit' - + .. py:attribute:: TOTAL :value: 'total' + .. py:class:: AlertActionType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: EMAIL :value: 'Email' + .. py:class:: PythonFunctionType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FEATURE_GROUP :value: 'FEATURE_GROUP' - + .. py:attribute:: PLOTLY_FIG :value: 'PLOTLY_FIG' - + .. py:attribute:: STEP_FUNCTION :value: 'STEP_FUNCTION' + .. py:class:: EvalArtifactType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FORECASTING_ACCURACY :value: 'bar_chart' - + .. py:attribute:: FORECASTING_VOLUME :value: 'bar_chart_volume' - + .. py:attribute:: FORECASTING_HISTORY_LENGTH_ACCURACY :value: 'bar_chart_accuracy_by_history' + .. py:class:: FieldDescriptorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: DATETIME :value: 'DATETIME' - + .. py:attribute:: DATE :value: 'DATE' + .. py:class:: WorkflowNodeInputType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: USER_INPUT :value: 'USER_INPUT' - + .. py:attribute:: WORKFLOW_VARIABLE :value: 'WORKFLOW_VARIABLE' + .. py:class:: WorkflowNodeOutputType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ATTACHMENT :value: 'ATTACHMENT' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: DICT :value: 'DICT' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: STRING :value: 'STRING' + .. py:class:: OcrMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEFAULT :value: 'DEFAULT' - + .. py:attribute:: LAYOUT :value: 'LAYOUT' - + .. py:attribute:: SCANNED :value: 'SCANNED' - + .. py:attribute:: COMPREHENSIVE :value: 'COMPREHENSIVE' - + .. py:attribute:: COMPREHENSIVE_V2 :value: 'COMPREHENSIVE_V2' - + .. py:attribute:: COMPREHENSIVE_TABLE_MD :value: 'COMPREHENSIVE_TABLE_MD' + + + .. py:attribute:: TESSERACT_FAST + :value: 'TESSERACT_FAST' + + .. py:class:: StdDevThresholdType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ABSOLUTE :value: 'ABSOLUTE' - + .. py:attribute:: PERCENTILE :value: 'PERCENTILE' - + .. py:attribute:: STDDEV :value: 'STDDEV' + .. py:class:: DataType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: INTEGER :value: 'integer' - + .. py:attribute:: FLOAT :value: 'float' - + .. py:attribute:: STRING :value: 'string' - + .. py:attribute:: DATE :value: 'date' - + .. py:attribute:: DATETIME :value: 'datetime' - + .. py:attribute:: BOOLEAN :value: 'boolean' + + + .. py:attribute:: LIST + :value: 'list' + + + + .. py:attribute:: STRUCT + :value: 'struct' + + + + .. py:attribute:: NULL + :value: 'null' + + + + .. py:attribute:: BINARY + :value: 'binary' + + - .. py:attribute:: LIST - :value: 'list' +.. py:class:: AgentInterface + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: DEFAULT + :value: 'DEFAULT' + + + + .. py:attribute:: CHAT + :value: 'CHAT' + + + + +.. py:class:: ProjectConfigType + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. + .. py:attribute:: CONSTRAINTS + :value: 'CONSTRAINTS' + - .. py:attribute:: STRUCT - :value: 'struct' + .. py:attribute:: CHAT_FEEDBACK + :value: 'CHAT_FEEDBACK' + + .. py:attribute:: REVIEW_MODE + :value: 'REVIEW_MODE' - .. py:attribute:: NULL - :value: 'null' + +.. py:class:: CPUSize -.. py:class:: AgentInterface Bases: :py:obj:`ApiEnum` - Generic enumeration. Derive from this class to define new enumerations. + .. py:attribute:: SMALL + :value: 'small' - .. py:attribute:: DEFAULT - :value: 'DEFAULT' + + .. py:attribute:: MEDIUM + :value: 'medium' + - .. py:attribute:: CHAT - :value: 'CHAT' + .. py:attribute:: LARGE + :value: 'large' + -.. py:class:: ProjectConfigType +.. py:class:: MemorySize - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. + .. py:attribute:: SMALL + :value: 16 - .. py:attribute:: CONSTRAINTS - :value: 'CONSTRAINTS' + + + .. py:attribute:: MEDIUM + :value: 32 + + .. py:attribute:: LARGE + :value: 64 - .. py:attribute:: REVIEW_MODE - :value: 'REVIEW_MODE' + + + .. py:attribute:: XLARGE + :value: 128 + + + + .. py:method:: from_value(value) + :classmethod: .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -4751,13 +5132,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -4783,7 +5162,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -4791,178 +5169,239 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: -.. py:class:: SamplingConfig +.. py:class:: DocumentProcessingConfig + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Document processing configuration. + + :param extract_bounding_boxes: Whether to perform OCR and extract bounding boxes. If False, no OCR will be done but only the embedded text from digital documents will be extracted. Defaults to False. + :type extract_bounding_boxes: bool + :param ocr_mode: OCR mode. There are different OCR modes available for different kinds of documents and use cases. This option only takes effect when extract_bounding_boxes is True. + :type ocr_mode: OcrMode + :param use_full_ocr: Whether to perform full OCR. If True, OCR will be performed on the full page. If False, OCR will be performed on the non-text regions only. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. + :type use_full_ocr: bool + :param remove_header_footer: Whether to remove headers and footers. Defaults to False. This option only takes effect when extract_bounding_boxes is True. + :type remove_header_footer: bool + :param remove_watermarks: Whether to remove watermarks. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. + :type remove_watermarks: bool + :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. + :type convert_to_markdown: bool + :param return_links: Whether to augment the extracted text with embedded URLs in the PDF. Defaults to False. This option only takes effect when the document is a PDF. + :type return_links: bool - An abstract class for the sampling config of a feature group + .. py:attribute:: extract_bounding_boxes + :type: bool + :value: False + + + .. py:attribute:: ocr_mode + :type: abacusai.api_class.enums.OcrMode + + + + .. py:attribute:: use_full_ocr + :type: bool + + + + .. py:attribute:: remove_header_footer + :type: bool + :value: False + + + + .. py:attribute:: remove_watermarks + :type: bool + :value: True + + + + .. py:attribute:: convert_to_markdown + :type: bool + :value: False + + + + .. py:attribute:: return_links + :type: bool + :value: False + + + + +.. py:class:: SamplingConfig + + + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + + An abstract class for the sampling config of a feature group .. py:attribute:: sampling_method - :type: abacusai.api_class.enums.SamplingMethodType + :type: abacusai.api_class.enums.SamplingMethodType + .. py:method:: _get_builder() :classmethod: - .. py:method:: __post_init__() + .. py:class:: NSamplingConfig - Bases: :py:obj:`SamplingConfig` + Bases: :py:obj:`SamplingConfig` The number of distinct values of the key columns to include in the sample, or number of rows if key columns not specified. - :param sampling_method: N_SAMPLING - :type sampling_method: SamplingMethodType :param sample_count: The number of rows to include in the sample :type sample_count: int :param key_columns: The feature(s) to use as the key(s) when sampling :type key_columns: List[str] - .. py:attribute:: sample_count - :type: int + :type: int + .. py:attribute:: key_columns - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: PercentSamplingConfig - Bases: :py:obj:`SamplingConfig` + Bases: :py:obj:`SamplingConfig` The fraction of distinct values of the feature group to include in the sample. - :param sampling_method: PERCENT_SAMPLING - :type sampling_method: SamplingMethodType :param sample_percent: The percentage of the rows to sample :type sample_percent: float :param key_columns: The feature(s) to use as the key(s) when sampling :type key_columns: List[str] - .. py:attribute:: sample_percent - :type: float + :type: float + .. py:attribute:: key_columns - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: _SamplingConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_class_key :value: 'sampling_method' - + .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_map + + .. py:class:: MergeConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for the merge config of a feature group - .. py:attribute:: merge_mode - :type: abacusai.api_class.enums.MergeMode + :type: abacusai.api_class.enums.MergeMode + .. py:method:: _get_builder() :classmethod: - .. py:method:: __post_init__() + .. py:class:: LastNMergeConfig - Bases: :py:obj:`MergeConfig` + Bases: :py:obj:`MergeConfig` Merge LAST N chunks/versions of an incremental dataset. - :param merge_mode: LAST_N - :type merge_mode: MergeMode :param num_versions: The number of versions to merge. num_versions == 0 means merge all versions. :type num_versions: int :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. :type include_version_timestamp_column: bool - .. py:attribute:: num_versions - :type: int + :type: int + .. py:attribute:: include_version_timestamp_column - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TimeWindowMergeConfig - Bases: :py:obj:`MergeConfig` + Bases: :py:obj:`MergeConfig` Merge rows within a given timewindow of the most recent timestamp - :param merge_mode: TIME_WINDOW - :type merge_mode: MergeMode :param feature_name: Time based column to index on :type feature_name: str :param time_window_size_ms: Range of merged rows will be [MAX_TIME - time_window_size_ms, MAX_TIME] @@ -4970,58 +5409,275 @@ Package Contents :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. :type include_version_timestamp_column: bool - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: time_window_size_ms - :type: int + :type: int + .. py:attribute:: include_version_timestamp_column - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _MergeConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_class_key :value: 'merge_mode' + + + .. py:attribute:: config_abstract_class + + + + .. py:attribute:: config_class_map + + + + +.. py:class:: OperatorConfig + + + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + + Configuration for a template Feature Group Operation + + .. py:attribute:: operator_type + :type: abacusai.api_class.enums.OperatorType + + + + .. py:method:: _get_builder() + :classmethod: + + + .. py:method:: __post_init__() + + + +.. py:class:: UnpivotConfig + + + Bases: :py:obj:`OperatorConfig` + + Unpivot Columns in a FeatureGroup. + + :param columns: Which columns to unpivot. + :type columns: List[str] + :param index_column: Name of new column containing the unpivoted column names as its values + :type index_column: str + :param value_column: Name of new column containing the row values that were unpivoted. + :type value_column: str + :param exclude: If True, the unpivoted columns are all the columns EXCEPT the ones in the columns argument. Default is False. + :type exclude: bool + + .. py:attribute:: columns + :type: List[str] + + + + .. py:attribute:: index_column + :type: str + + + + .. py:attribute:: value_column + :type: str + + + + .. py:attribute:: exclude + :type: bool + + + + .. py:method:: __post_init__() + + + +.. py:class:: MarkdownConfig + + + Bases: :py:obj:`OperatorConfig` + + Transform a input column to a markdown column. + + :param input_column: Name of input column to transform. + :type input_column: str + :param output_column: Name of output column to store transformed data. + :type output_column: str + :param input_column_type: Type of input column to transform. + :type input_column_type: MarkdownOperatorInputType + + .. py:attribute:: input_column + :type: str + + + + .. py:attribute:: output_column + :type: str + + + + .. py:attribute:: input_column_type + :type: abacusai.api_class.enums.MarkdownOperatorInputType + + + + .. py:method:: __post_init__() + + + +.. py:class:: CrawlerTransformConfig + + + Bases: :py:obj:`OperatorConfig` + + Transform a input column of urls to html text + + :param input_column: Name of input column to transform. + :type input_column: str + :param output_column: Name of output column to store transformed data. + :type output_column: str + :param depth_column: Increasing depth explores more links, capturing more content + :type depth_column: str + :param disable_host_restriction: If True, will not restrict crawling to the same host. + :type disable_host_restriction: bool + :param honour_website_rules: If True, will respect robots.txt rules. + :type honour_website_rules: bool + :param user_agent: If provided, will use this user agent instead of randomly selecting one. + :type user_agent: str + + .. py:attribute:: input_column + :type: str + + + + .. py:attribute:: output_column + :type: str + + + + .. py:attribute:: depth_column + :type: str + + + + .. py:attribute:: input_column_type + :type: str + + + + .. py:attribute:: crawl_depth + :type: int + + + .. py:attribute:: disable_host_restriction + :type: bool + + + + .. py:attribute:: honour_website_rules + :type: bool + + + + .. py:attribute:: user_agent + :type: str + + + + .. py:method:: __post_init__() + + + +.. py:class:: ExtractDocumentDataConfig + + + Bases: :py:obj:`OperatorConfig` + + Extracts data from documents. + + :param doc_id_column: Name of input document ID column. + :type doc_id_column: str + :param document_column: Name of the input document column which contains the page infos. This column will be transformed to include the document processing config in the output feature group. + :type document_column: str + :param document_processing_config: Document processing configuration. + :type document_processing_config: DocumentProcessingConfig + + .. py:attribute:: doc_id_column + :type: str + + + + .. py:attribute:: document_column + :type: str + + + + .. py:attribute:: document_processing_config + :type: abacusai.api_class.dataset.DocumentProcessingConfig + + + + .. py:method:: __post_init__() + + + +.. py:class:: _OperatorConfigFactory + + + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + + A class to select and return the the correct type of Operator Config based on a serialized OperatorConfig instance. .. py:attribute:: config_abstract_class + + + .. py:attribute:: config_class_key + :value: 'operator_type' + + .. py:attribute:: config_class_map + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -5030,13 +5686,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -5062,7 +5716,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -5070,25 +5723,23 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -5097,31 +5748,35 @@ Package Contents .. py:class:: TrainingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for the training config options used to train the model. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:attribute:: algorithm - :type: str + :type: str + .. py:method:: _get_builder() :classmethod: @@ -5130,8 +5785,8 @@ Package Contents .. py:class:: PersonalizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the PERSONALIZATION problem type @@ -5210,162 +5865,199 @@ Package Contents :param item_query_column: Name of column in the item catalog that will be matched to the query column in the interactions table. :type item_query_column: str - .. py:attribute:: objective - :type: abacusai.api_class.enums.PersonalizationObjective + :type: abacusai.api_class.enums.PersonalizationObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.PersonalizationObjective + :type: abacusai.api_class.enums.PersonalizationObjective + .. py:attribute:: training_mode - :type: abacusai.api_class.enums.PersonalizationTrainingMode + :type: abacusai.api_class.enums.PersonalizationTrainingMode + .. py:attribute:: target_action_types - :type: List[str] + :type: List[str] + .. py:attribute:: target_action_weights - :type: Dict[str, float] + :type: Dict[str, float] + .. py:attribute:: session_event_types - :type: List[str] + :type: List[str] + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: recent_days_for_training - :type: int + :type: int + .. py:attribute:: training_start_date - :type: str + :type: str + .. py:attribute:: test_on_user_split - :type: bool + :type: bool + .. py:attribute:: test_split_on_last_k_items - :type: bool + :type: bool + .. py:attribute:: test_last_items_length - :type: int + :type: int + .. py:attribute:: test_window_length_hours - :type: int + :type: int + .. py:attribute:: explicit_time_split - :type: bool + :type: bool + .. py:attribute:: test_row_indicator - :type: str + :type: str + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: sequential_training - :type: bool + :type: bool + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: optimized_event_type - :type: str + :type: str + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: disable_transformer - :type: bool + :type: bool + .. py:attribute:: disable_gpu - :type: bool + :type: bool + .. py:attribute:: filter_history - :type: bool + :type: bool + .. py:attribute:: action_types_exclusion_days - :type: Dict[str, float] + :type: Dict[str, float] + .. py:attribute:: max_history_length - :type: int + :type: int + .. py:attribute:: compute_rerank_metrics - :type: bool + :type: bool + .. py:attribute:: add_time_features - :type: bool + :type: bool + .. py:attribute:: disable_timestamp_scalar_features - :type: bool + :type: bool + .. py:attribute:: compute_session_metrics - :type: bool + :type: bool + .. py:attribute:: query_column - :type: str + :type: str + .. py:attribute:: item_query_column - :type: str + :type: str + .. py:attribute:: use_user_id_feature - :type: bool + :type: bool + .. py:attribute:: session_dedupe_mins - :type: float + :type: float + .. py:attribute:: max_user_history_len_percentile - :type: int + :type: int + .. py:attribute:: downsample_item_popularity_percentile - :type: float + :type: float + .. py:attribute:: min_item_history - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: RegressionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the PREDICTIVE_MODELING problem type @@ -5451,179 +6143,227 @@ Package Contents :type custom_metrics: List[str] :param partial_dependence_analysis: Specify whether to run partial dependence plots for all features or only some features. :type partial_dependence_analysis: PartialDependenceAnalysis - + :param do_masked_language_model_pretraining: Specify whether to run a masked language model unsupervised pretraining step before supervized training in certain supported algorithms which use BERT-like backbones. + :type do_masked_language_model_pretraining: bool .. py:attribute:: objective - :type: abacusai.api_class.enums.RegressionObjective + :type: abacusai.api_class.enums.RegressionObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.RegressionObjective + :type: abacusai.api_class.enums.RegressionObjective + .. py:attribute:: tree_hpo_mode - :type: abacusai.api_class.enums.RegressionTreeHPOMode + :type: abacusai.api_class.enums.RegressionTreeHPOMode + .. py:attribute:: partial_dependence_analysis - :type: abacusai.api_class.enums.PartialDependenceAnalysis + :type: abacusai.api_class.enums.PartialDependenceAnalysis + .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.RegressionTypeOfSplit + :type: abacusai.api_class.enums.RegressionTypeOfSplit + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: disable_test_val_fold - :type: bool + :type: bool + .. py:attribute:: k_fold_cross_validation - :type: bool + :type: bool + .. py:attribute:: num_cv_folds - :type: int + :type: int + .. py:attribute:: timestamp_based_splitting_column - :type: str + :type: str + .. py:attribute:: timestamp_based_splitting_method - :type: abacusai.api_class.enums.RegressionTimeSplitMethod + :type: abacusai.api_class.enums.RegressionTimeSplitMethod + .. py:attribute:: test_splitting_timestamp - :type: str + :type: str + .. py:attribute:: sampling_unit_keys - :type: List[str] + :type: List[str] + .. py:attribute:: test_row_indicator - :type: str + :type: str + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: rebalance_classes - :type: bool + :type: bool + .. py:attribute:: rare_class_augmentation_threshold - :type: float + :type: float + .. py:attribute:: augmentation_strategy - :type: abacusai.api_class.enums.RegressionAugmentationStrategy + :type: abacusai.api_class.enums.RegressionAugmentationStrategy + .. py:attribute:: training_rows_downsample_ratio - :type: float + :type: float + .. py:attribute:: active_labels_column - :type: str + :type: str + .. py:attribute:: min_categorical_count - :type: int + :type: int + .. py:attribute:: sample_weight - :type: str + :type: str + .. py:attribute:: numeric_clipping_percentile - :type: float + :type: float + .. py:attribute:: target_transform - :type: abacusai.api_class.enums.RegressionTargetTransform + :type: abacusai.api_class.enums.RegressionTargetTransform + .. py:attribute:: ignore_datetime_features - :type: bool + :type: bool + .. py:attribute:: max_text_words - :type: int + :type: int + .. py:attribute:: perform_feature_selection - :type: bool + :type: bool + .. py:attribute:: feature_selection_intensity - :type: int + :type: int + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: pretrained_model_name - :type: str + :type: str + .. py:attribute:: is_multilingual - :type: bool + :type: bool + + + .. py:attribute:: do_masked_language_model_pretraining + :type: bool + + .. py:attribute:: loss_function - :type: abacusai.api_class.enums.RegressionLossFunction + :type: abacusai.api_class.enums.RegressionLossFunction + .. py:attribute:: loss_parameters - :type: str + :type: str + .. py:attribute:: target_encode_categoricals - :type: bool + :type: bool + .. py:attribute:: drop_original_categoricals - :type: bool + :type: bool + .. py:attribute:: monotonically_increasing_features - :type: List[str] + :type: List[str] + .. py:attribute:: monotonically_decreasing_features - :type: List[str] + :type: List[str] + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: custom_loss_functions - :type: List[str] + :type: List[str] + .. py:attribute:: custom_metrics - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: ForecastingTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the FORECASTING problem type @@ -5750,262 +6490,324 @@ Package Contents :type custom_metrics: List[str] :param return_fractional_forecasts: Use this to return fractional forecast values while prediction - .. py:attribute:: prediction_length - :type: int + :type: int + .. py:attribute:: objective - :type: abacusai.api_class.enums.ForecastingObjective + :type: abacusai.api_class.enums.ForecastingObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.ForecastingObjective + :type: abacusai.api_class.enums.ForecastingObjective + .. py:attribute:: forecast_frequency - :type: abacusai.api_class.enums.ForecastingFrequency + :type: abacusai.api_class.enums.ForecastingFrequency + .. py:attribute:: probability_quantiles - :type: List[float] + :type: List[float] + .. py:attribute:: force_prediction_length - :type: bool + :type: bool + .. py:attribute:: filter_items - :type: bool + :type: bool + .. py:attribute:: enable_feature_selection - :type: bool + :type: bool + .. py:attribute:: enable_padding - :type: bool + :type: bool + .. py:attribute:: enable_cold_start - :type: bool + :type: bool + .. py:attribute:: enable_multiple_backtests - :type: bool + :type: bool + .. py:attribute:: num_backtesting_windows - :type: int + :type: int + .. py:attribute:: backtesting_window_step_size - :type: int + :type: int + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: additional_forecast_keys - :type: List[str] + :type: List[str] + .. py:attribute:: experimentation_mode - :type: abacusai.api_class.enums.ExperimentationMode + :type: abacusai.api_class.enums.ExperimentationMode + .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.ForecastingDataSplitType + :type: abacusai.api_class.enums.ForecastingDataSplitType + .. py:attribute:: test_by_item - :type: bool + :type: bool + .. py:attribute:: test_start - :type: str + :type: str + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: loss_function - :type: abacusai.api_class.enums.ForecastingLossFunction + :type: abacusai.api_class.enums.ForecastingLossFunction + .. py:attribute:: underprediction_weight - :type: float + :type: float + .. py:attribute:: disable_networks_without_analytic_quantiles - :type: bool + :type: bool + .. py:attribute:: initial_learning_rate - :type: float + :type: float + .. py:attribute:: l2_regularization_factor - :type: float + :type: float + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: recurrent_layers - :type: int + :type: int + .. py:attribute:: recurrent_units - :type: int + :type: int + .. py:attribute:: convolutional_layers - :type: int + :type: int + .. py:attribute:: convolution_filters - :type: int + :type: int + .. py:attribute:: local_scaling_mode - :type: abacusai.api_class.enums.ForecastingLocalScaling + :type: abacusai.api_class.enums.ForecastingLocalScaling + .. py:attribute:: zero_predictor - :type: bool + :type: bool + .. py:attribute:: skip_missing - :type: bool + :type: bool + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: batch_renormalization - :type: bool + :type: bool + .. py:attribute:: history_length - :type: int + :type: int + .. py:attribute:: prediction_step_size - :type: int + :type: int + .. py:attribute:: training_point_overlap - :type: float + :type: float + .. py:attribute:: max_scale_context - :type: int + :type: int + .. py:attribute:: quantiles_extension_method - :type: abacusai.api_class.enums.ForecastingQuanitlesExtensionMethod + :type: abacusai.api_class.enums.ForecastingQuanitlesExtensionMethod + .. py:attribute:: number_of_samples - :type: int + :type: int + .. py:attribute:: symmetrize_quantiles - :type: bool + :type: bool + .. py:attribute:: use_log_transforms - :type: bool + :type: bool + .. py:attribute:: smooth_history - :type: float + :type: float + .. py:attribute:: local_scale_target - :type: bool + :type: bool + .. py:attribute:: use_clipping - :type: bool + :type: bool + .. py:attribute:: timeseries_weight_column - :type: str + :type: str + .. py:attribute:: item_attributes_weight_column - :type: str + :type: str + .. py:attribute:: use_timeseries_weights_in_objective - :type: bool + :type: bool + .. py:attribute:: use_item_weights_in_objective - :type: bool + :type: bool + .. py:attribute:: skip_timeseries_weight_scaling - :type: bool + :type: bool + .. py:attribute:: timeseries_loss_weight_column - :type: str + :type: str + .. py:attribute:: use_item_id - :type: bool + :type: bool + .. py:attribute:: use_all_item_totals - :type: bool + :type: bool + .. py:attribute:: handle_zeros_as_missing_values - :type: bool + :type: bool + .. py:attribute:: datetime_holiday_calendars - :type: List[abacusai.api_class.enums.HolidayCalendars] + :type: List[abacusai.api_class.enums.HolidayCalendars] + .. py:attribute:: fill_missing_values - :type: List[dict] + :type: List[dict] + .. py:attribute:: enable_clustering - :type: bool + :type: bool + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: custom_loss_functions - :type: List[str] + :type: List[str] + .. py:attribute:: custom_metrics - :type: List[str] + :type: List[str] + .. py:attribute:: return_fractional_forecasts - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NamedEntityExtractionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the NAMED_ENTITY_EXTRACTION problem type @@ -6026,62 +6828,57 @@ Package Contents :param enhanced_ocr: Enhanced text extraction from predicted digital documents :type enhanced_ocr: bool - .. py:attribute:: llm_for_ner - :type: abacusai.api_class.enums.LLMName - :value: None - + :type: abacusai.api_class.enums.LLMName + .. py:attribute:: test_split - :type: int - :value: None - + :type: int + .. py:attribute:: test_row_indicator - :type: str - :value: None - + :type: str + .. py:attribute:: active_labels_column - :type: str - :value: None - + :type: str + .. py:attribute:: document_format - :type: abacusai.api_class.enums.NLPDocumentFormat - :value: None - + :type: abacusai.api_class.enums.NLPDocumentFormat + .. py:attribute:: minimum_bounding_box_overlap_ratio - :type: float + :type: float :value: 0.0 - + .. py:attribute:: save_predicted_pdf - :type: bool + :type: bool :value: True - + .. py:attribute:: enhanced_ocr - :type: bool + :type: bool :value: False - + .. py:method:: __post_init__() + .. py:class:: NaturalLanguageSearchTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the NATURAL_LANGUAGE_SEARCH problem type @@ -6098,38 +6895,44 @@ Package Contents :param index_fraction: Fraction of the chunk to use for indexing. :type index_fraction: float - .. py:attribute:: abacus_internal_model - :type: bool + :type: bool + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: larger_embeddings - :type: bool + :type: bool + .. py:attribute:: search_chunk_size - :type: int + :type: int + .. py:attribute:: index_fraction - :type: float + :type: float + .. py:attribute:: chunk_overlap_fraction - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: ChatLLMTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CHAT_LLM problem type @@ -6177,110 +6980,134 @@ Package Contents :param enable_code_execution: Enable python code execution in the ChatLLM. This equips the LLM with a python kernel in which all its code is executed. :type enable_code_execution: bool - .. py:attribute:: document_retrievers - :type: List[str] + :type: List[str] + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: retrieval_columns - :type: list + :type: list + .. py:attribute:: filter_columns - :type: list + :type: list + .. py:attribute:: include_general_knowledge - :type: bool + :type: bool + .. py:attribute:: enable_web_search - :type: bool + :type: bool + .. py:attribute:: behavior_instructions - :type: str + :type: str + .. py:attribute:: response_instructions - :type: str + :type: str + .. py:attribute:: enable_llm_rewrite - :type: bool + :type: bool + .. py:attribute:: column_filtering_instructions - :type: str + :type: str + .. py:attribute:: keyword_requirement_instructions - :type: str + :type: str + .. py:attribute:: query_rewrite_instructions - :type: str + :type: str + .. py:attribute:: max_search_results - :type: int + :type: int + .. py:attribute:: data_feature_group_ids - :type: List[str] + :type: List[str] + .. py:attribute:: data_prompt_context - :type: str + :type: str + .. py:attribute:: hide_generated_sql - :type: bool + :type: bool + .. py:attribute:: disable_data_summarization - :type: bool + :type: bool + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: database_connector_id - :type: str + :type: str + .. py:attribute:: database_connector_tables - :type: List[str] + :type: List[str] + .. py:attribute:: enable_code_execution - :type: bool + :type: bool + .. py:attribute:: metadata_columns - :type: list + :type: list + .. py:attribute:: lookup_rewrite_instructions - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: SentenceBoundaryDetectionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the SENTENCE_BOUNDARY_DETECTION problem type @@ -6291,26 +7118,29 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: SentimentDetectionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the SENTIMENT_DETECTION problem type @@ -6325,34 +7155,39 @@ Package Contents :param compute_metrics: Whether to compute metrics. :type compute_metrics: bool - .. py:attribute:: sentiment_type - :type: abacusai.api_class.enums.SentimentType + :type: abacusai.api_class.enums.SentimentType + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: compute_metrics - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: DocumentClassificationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_CLASSIFICATION problem type @@ -6365,30 +7200,34 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: zero_shot_hypotheses - :type: List[str] + :type: List[str] + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: DocumentSummarizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_SUMMARIZATION problem type @@ -6399,26 +7238,29 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: DocumentVisualizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_VISUALIZATION problem type @@ -6429,44 +7271,48 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: ClusteringTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CLUSTERING problem type :param num_clusters_selection: Number of clusters. If None, will be selected automatically. :type num_clusters_selection: int - .. py:attribute:: num_clusters_selection - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: ClusteringTimeseriesTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CLUSTERING_TIMESERIES problem type @@ -6475,40 +7321,43 @@ Package Contents :param imputation: Imputation method for missing values. :type imputation: ClusteringImputationMethod - .. py:attribute:: num_clusters_selection - :type: int + :type: int + .. py:attribute:: imputation - :type: abacusai.api_class.enums.ClusteringImputationMethod + :type: abacusai.api_class.enums.ClusteringImputationMethod + .. py:method:: __post_init__() + .. py:class:: EventAnomalyTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the EVENT_ANOMALY problem type :param anomaly_fraction: The fraction of the dataset to classify as anomalous, between 0 and 0.5 :type anomaly_fraction: float - .. py:attribute:: anomaly_fraction - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: TimeseriesAnomalyTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the TS_ANOMALY problem type @@ -6533,54 +7382,64 @@ Package Contents :param threshold_score: Threshold score for anomaly detection :type threshold_score: float - .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.TimeseriesAnomalyDataSplitType + :type: abacusai.api_class.enums.TimeseriesAnomalyDataSplitType + .. py:attribute:: test_start - :type: str + :type: str + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: fill_missing_values - :type: List[dict] + :type: List[dict] + .. py:attribute:: handle_zeros_as_missing_values - :type: bool + :type: bool + .. py:attribute:: timeseries_frequency - :type: str + :type: str + .. py:attribute:: min_samples_in_normal_region - :type: int + :type: int + .. py:attribute:: anomaly_type - :type: abacusai.api_class.enums.TimeseriesAnomalyTypeOfAnomaly + :type: abacusai.api_class.enums.TimeseriesAnomalyTypeOfAnomaly + .. py:attribute:: hyperparameter_calculation_with_heuristics - :type: abacusai.api_class.enums.TimeseriesAnomalyUseHeuristic + :type: abacusai.api_class.enums.TimeseriesAnomalyUseHeuristic + .. py:attribute:: threshold_score - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: CumulativeForecastingTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUMULATIVE_FORECASTING problem type @@ -6597,49 +7456,55 @@ Package Contents :param predict_residuals: Predict residuals instead of totals at each prediction step. :type predict_residuals: bool - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: historical_frequency - :type: str + :type: str + .. py:attribute:: cumulative_prediction_lengths - :type: List[int] + :type: List[int] + .. py:attribute:: skip_input_transform - :type: bool + :type: bool + .. py:attribute:: skip_target_transform - :type: bool + :type: bool + .. py:attribute:: predict_residuals - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ThemeAnalysisTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the THEME ANALYSIS problem type - .. py:method:: __post_init__() + .. py:class:: AIAgentTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the AI_AGENT problem type @@ -6648,34 +7513,39 @@ Package Contents :param agent_interface: The interface that the agent will be deployed with. :type agent_interface: AgentInterface - .. py:attribute:: description - :type: str + :type: str + .. py:attribute:: agent_interface - :type: abacusai.api_class.enums.AgentInterface + :type: abacusai.api_class.enums.AgentInterface + .. py:attribute:: enable_binary_input - :type: bool + :type: bool + .. py:attribute:: agent_input_schema - :type: dict + :type: dict + .. py:attribute:: agent_output_schema - :type: dict + :type: dict + .. py:method:: __post_init__() + .. py:class:: CustomTrainedModelTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUSTOM_TRAINED_MODEL problem type @@ -6692,56 +7562,63 @@ Package Contents :param streaming_embeddings: Flag to enable streaming embeddings. :type streaming_embeddings: bool - .. py:attribute:: max_catalog_size - :type: int + :type: int + .. py:attribute:: max_dimension - :type: int + :type: int + .. py:attribute:: index_output_path - :type: str + :type: str + .. py:attribute:: docker_image_uri - :type: str + :type: str + .. py:attribute:: service_port - :type: int + :type: int + .. py:attribute:: streaming_embeddings - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: CustomAlgorithmTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUSTOM_ALGORITHM problem type :param timeout_minutes: Timeout for the model training in minutes. :type timeout_minutes: int - .. py:attribute:: timeout_minutes - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: OptimizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the OPTIMIZATION problem type @@ -6750,42 +7627,46 @@ Package Contents :param optimality_gap_limit: The stopping optimality gap limit. Optimality gap is fractional difference between the best known solution and the best possible solution. Accepts values between 0 and 1. :type optimality_gap_limit: float - .. py:attribute:: solve_time_limit - :type: float + :type: float + .. py:attribute:: optimality_gap_limit - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: _TrainingConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + .. py:class:: DeployableAlgorithm - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Algorithm that can be deployed to a model. @@ -6798,39 +7679,44 @@ Package Contents :param trained_model_types: List of trained model types. :type trained_model_types: List[dict] - .. py:attribute:: algorithm - :type: str + :type: str + .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: only_offline_deployable - :type: bool + :type: bool + .. py:attribute:: trained_model_types - :type: List[dict] + :type: List[dict] + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -6839,13 +7725,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -6871,7 +7755,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -6879,33 +7762,33 @@ Package Contents .. py:class:: StdDevThresholdType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ABSOLUTE :value: 'ABSOLUTE' - + .. py:attribute:: PERCENTILE :value: 'PERCENTILE' - + .. py:attribute:: STDDEV :value: 'STDDEV' + .. py:class:: TimeWindowConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Time Window Configuration @@ -6914,14 +7797,15 @@ Package Contents :param window_from_start: Whether the window should be from the start of the time series. :type window_from_start: bool - .. py:attribute:: window_duration - :type: int + :type: int + .. py:attribute:: window_from_start - :type: bool + :type: bool + .. py:method:: to_dict() @@ -6933,8 +7817,8 @@ Package Contents .. py:class:: ForecastingMonitorConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Forecasting Monitor Configuration @@ -6951,30 +7835,35 @@ Package Contents :param window_config: The windowing configuration for the time series data. :type window_config: TimeWindowConfig - .. py:attribute:: id_column - :type: str + :type: str + .. py:attribute:: timestamp_column - :type: str + :type: str + .. py:attribute:: target_column - :type: str + :type: str + .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: window_config - :type: TimeWindowConfig + :type: TimeWindowConfig + .. py:method:: to_dict() @@ -6986,8 +7875,8 @@ Package Contents .. py:class:: StdDevThreshold - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Std Dev Threshold types @@ -6996,14 +7885,15 @@ Package Contents :param value: Value to use for the threshold. :type value: float - .. py:attribute:: threshold_type - :type: abacusai.api_class.enums.StdDevThresholdType + :type: abacusai.api_class.enums.StdDevThresholdType + .. py:attribute:: value - :type: float + :type: float + .. py:method:: to_dict() @@ -7015,8 +7905,8 @@ Package Contents .. py:class:: ItemAttributesStdDevThreshold - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Item Attributes Std Dev Threshold for Monitor Alerts @@ -7025,14 +7915,15 @@ Package Contents :param upper_bound: Upper bound for the item attributes. :type upper_bound: StdDevThreshold - .. py:attribute:: lower_bound - :type: StdDevThreshold + :type: StdDevThreshold + .. py:attribute:: upper_bound - :type: StdDevThreshold + :type: StdDevThreshold + .. py:method:: to_dict() @@ -7044,8 +7935,8 @@ Package Contents .. py:class:: RestrictFeatureMappings - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Restrict Feature Mappings for Monitor Filtering @@ -7062,30 +7953,35 @@ Package Contents :param max_value: Filtering the numerical feature to below this value :type max_value: float - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: restricted_feature_values - :type: list + :type: list + .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: min_value - :type: float + :type: float + .. py:attribute:: max_value - :type: float + :type: float + .. py:method:: to_dict() @@ -7097,8 +7993,8 @@ Package Contents .. py:class:: MonitorFilteringConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Monitor Filtering Configuration @@ -7115,30 +8011,35 @@ Package Contents :param prediction_target_feature: Set the target feature for the prediction data. :type prediction_target_feature: str - .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: restrict_feature_mappings - :type: List[RestrictFeatureMappings] + :type: List[RestrictFeatureMappings] + .. py:attribute:: target_class - :type: str + :type: str + .. py:attribute:: train_target_feature - :type: str + :type: str + .. py:attribute:: prediction_target_feature - :type: str + :type: str + .. py:method:: to_dict() @@ -7150,20 +8051,21 @@ Package Contents .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -7172,13 +8074,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -7204,7 +8104,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -7212,25 +8111,23 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -7239,15 +8136,15 @@ Package Contents .. py:class:: AlertConditionConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for alert condition configs - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType + :type: abacusai.api_class.enums.MonitorAlertType + .. py:method:: _get_builder() :classmethod: @@ -7256,26 +8153,27 @@ Package Contents .. py:class:: AccuracyBelowThresholdConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Accuracy Below Threshold Condition Config for Monitor Alerts :param threshold: Threshold for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: FeatureDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Feature Drift Condition Config for Monitor Alerts @@ -7288,30 +8186,34 @@ Package Contents :param feature_names: List of feature names to monitor for this alert. :type feature_names: List[str] - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:attribute:: feature_names - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: TargetDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Target Drift Condition Config for Monitor Alerts @@ -7320,22 +8222,24 @@ Package Contents :param threshold: Threshold for when to consider the target column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: HistoryLengthDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` History Length Drift Condition Config for Monitor Alerts @@ -7344,22 +8248,24 @@ Package Contents :param threshold: Threshold for when to consider the history length to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: DataIntegrityViolationConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Data Integrity Violation Condition Config for Monitor Alerts @@ -7368,22 +8274,24 @@ Package Contents :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int - .. py:attribute:: data_integrity_type - :type: abacusai.api_class.enums.DataIntegrityViolationType + :type: abacusai.api_class.enums.DataIntegrityViolationType + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: BiasViolationConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Bias Violation Condition Config for Monitor Alerts @@ -7394,26 +8302,29 @@ Package Contents :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int - .. py:attribute:: bias_type - :type: abacusai.api_class.enums.BiasType + :type: abacusai.api_class.enums.BiasType + .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: PredictionCountConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Deployment Prediction Condition Config for Deployment Alerts. By default we monitor if predictions made over a time window has reduced significantly. :param threshold: Threshold for when to consider to be a violation. Negative means alert on reduction, positive means alert on increase. @@ -7423,58 +8334,63 @@ Package Contents :param aggregation_type: Aggregation type to use for the aggregation window, e.g. sum, avg. :type aggregation_type: str - .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: aggregation_window - :type: str + :type: str + .. py:attribute:: aggregation_type - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _AlertConditionConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'alert_type' - + .. py:attribute:: config_class_key_value_camel_case :value: True - + .. py:attribute:: config_class_map + + .. py:class:: AlertActionConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for alert action configs - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType + :type: abacusai.api_class.enums.AlertActionType + .. py:method:: _get_builder() :classmethod: @@ -7483,8 +8399,8 @@ Package Contents .. py:class:: EmailActionConfig - Bases: :py:obj:`AlertActionConfig` + Bases: :py:obj:`AlertActionConfig` Email Action Config for Monitor Alerts @@ -7493,42 +8409,46 @@ Package Contents :param email_body: Body of the email to send. :type email_body: str - .. py:attribute:: email_recipients - :type: List[str] + :type: List[str] + .. py:attribute:: email_body - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _AlertActionConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'action_type' - + .. py:attribute:: config_class_map + + .. py:class:: MonitorThresholdConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Monitor Threshold Config for Monitor Alerts @@ -7537,18 +8457,20 @@ Package Contents :param threshold_config: Thresholds for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold_config: ThresholdConfigs - .. py:attribute:: drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: at_risk_threshold - :type: float + :type: float + .. py:attribute:: severely_drifting_threshold - :type: float + :type: float + .. py:method:: to_dict() @@ -7560,20 +8482,21 @@ Package Contents .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -7582,13 +8505,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -7614,7 +8535,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -7622,25 +8542,23 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -7649,8 +8567,8 @@ Package Contents .. py:class:: FeatureMappingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Feature mapping configuration for a feature group type. @@ -7661,23 +8579,26 @@ Package Contents :param nested_feature_name: The name of the nested feature in the feature group. :type nested_feature_name: str - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: feature_mapping - :type: str + :type: str + .. py:attribute:: nested_feature_name - :type: str + :type: str + + .. py:class:: ProjectFeatureGroupTypeMappingsConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Project feature group type mappings. @@ -7688,18 +8609,20 @@ Package Contents :param feature_mappings: The feature mappings for the feature group. :type feature_mappings: List[FeatureMappingConfig] - .. py:attribute:: feature_group_id - :type: str + :type: str + .. py:attribute:: feature_group_type - :type: str + :type: str + .. py:attribute:: feature_mappings - :type: List[FeatureMappingConfig] + :type: List[FeatureMappingConfig] + .. py:method:: from_dict(input_dict) :classmethod: @@ -7708,8 +8631,8 @@ Package Contents .. py:class:: ConstraintConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Constraint configuration. @@ -7724,38 +8647,43 @@ Package Contents :param penalty: The penalty for violating the constraint. :type penalty: float - .. py:attribute:: constant - :type: float + :type: float + .. py:attribute:: operator - :type: str + :type: str + .. py:attribute:: enforcement - :type: Optional[str] + :type: Optional[str] + .. py:attribute:: code - :type: Optional[str] + :type: Optional[str] + .. py:attribute:: penalty - :type: Optional[float] + :type: Optional[float] + + .. py:class:: ProjectFeatureGroupConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for project feature group configuration. - .. py:attribute:: type - :type: abacusai.api_class.enums.ProjectConfigType + :type: abacusai.api_class.enums.ProjectConfigType + .. py:method:: _get_builder() :classmethod: @@ -7764,76 +8692,81 @@ Package Contents .. py:class:: ConstraintProjectFeatureGroupConfig - Bases: :py:obj:`ProjectFeatureGroupConfig` + Bases: :py:obj:`ProjectFeatureGroupConfig` Constraint project feature group configuration. :param constraints: The constraint for the feature group. Should be a list of one ConstraintConfig. :type constraints: List[ConstraintConfig] - .. py:attribute:: constraints - :type: List[ConstraintConfig] + :type: List[ConstraintConfig] + .. py:method:: __post_init__() + .. py:class:: ReviewModeProjectFeatureGroupConfig - Bases: :py:obj:`ProjectFeatureGroupConfig` + Bases: :py:obj:`ProjectFeatureGroupConfig` Review mode project feature group configuration. :param is_review_mode: The review mode for the feature group. :type is_review_mode: bool - .. py:attribute:: is_review_mode - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _ProjectFeatureGroupConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'type' - + .. py:attribute:: config_class_map + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -7842,13 +8775,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -7874,7 +8805,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -7882,8 +8812,8 @@ Package Contents .. py:class:: PythonFunctionArgument - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for python function arguments @@ -7898,31 +8828,36 @@ Package Contents :param pipeline_variable: The name of the pipeline variable to use as the value :type pipeline_variable: str - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionArgumentType + :type: abacusai.api_class.enums.PythonFunctionArgumentType + .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: is_required - :type: bool + :type: bool + .. py:attribute:: value - :type: Any + :type: Any + .. py:attribute:: pipeline_variable - :type: str + :type: str + + .. py:class:: OutputVariableMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for python function arguments @@ -7931,31 +8866,34 @@ Package Contents :param name: The name of the python function variable :type name: str - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionOutputArgumentType + :type: abacusai.api_class.enums.PythonFunctionOutputArgumentType + .. py:attribute:: name - :type: str + :type: str + + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -7964,13 +8902,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -7996,7 +8932,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -8004,25 +8939,23 @@ Package Contents .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -8031,15 +8964,15 @@ Package Contents .. py:class:: FeatureGroupExportConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for feature group exports. - .. py:attribute:: connector_type - :type: abacusai.api_class.enums.ConnectorType + :type: abacusai.api_class.enums.ConnectorType + .. py:method:: _get_builder() :classmethod: @@ -8048,8 +8981,8 @@ Package Contents .. py:class:: FileConnectorExportConfig - Bases: :py:obj:`FeatureGroupExportConfig` + Bases: :py:obj:`FeatureGroupExportConfig` File connector export config for feature groups @@ -8058,14 +8991,15 @@ Package Contents :param export_file_format: The file format to export the feature group to :type export_file_format: str - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: export_file_format - :type: str + :type: str + .. py:method:: __post_init__() @@ -8080,8 +9014,8 @@ Package Contents .. py:class:: DatabaseConnectorExportConfig - Bases: :py:obj:`FeatureGroupExportConfig` + Bases: :py:obj:`FeatureGroupExportConfig` Database connector export config for feature groups @@ -8098,30 +9032,35 @@ Package Contents :param data_columns: The data columns to export the feature group to :type data_columns: Dict[str, str] - .. py:attribute:: database_connector_id - :type: str + :type: str + .. py:attribute:: mode - :type: str + :type: str + .. py:attribute:: object_name - :type: str + :type: str + .. py:attribute:: id_column - :type: str + :type: str + .. py:attribute:: additional_id_columns - :type: List[str] + :type: List[str] + .. py:attribute:: data_columns - :type: Dict[str, str] + :type: Dict[str, str] + .. py:method:: __post_init__() @@ -8136,21 +9075,23 @@ Package Contents .. py:class:: _FeatureGroupExportConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'connector_type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/model/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/model/index.rst.txt index bc90d6b5f..5bec30269 100644 --- a/docs/_sources/autoapi/abacusai/api_class/model/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/model/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.model -======================== +:py:mod:`abacusai.api_class.model` +================================== .. py:module:: abacusai.api_class.model +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.model.ApiClass - abacusai.api_class.model._ApiClassFactory abacusai.api_class.model.TrainingConfig abacusai.api_class.model.PersonalizationTrainingConfig abacusai.api_class.model.RegressionTrainingConfig @@ -37,125 +38,39 @@ Classes abacusai.api_class.model.DeployableAlgorithm -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - .. py:class:: TrainingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for the training config options used to train the model. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:attribute:: algorithm - :type: str + :type: str + .. py:method:: _get_builder() :classmethod: @@ -164,8 +79,8 @@ Module Contents .. py:class:: PersonalizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the PERSONALIZATION problem type @@ -244,162 +159,199 @@ Module Contents :param item_query_column: Name of column in the item catalog that will be matched to the query column in the interactions table. :type item_query_column: str - .. py:attribute:: objective - :type: abacusai.api_class.enums.PersonalizationObjective + :type: abacusai.api_class.enums.PersonalizationObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.PersonalizationObjective + :type: abacusai.api_class.enums.PersonalizationObjective + .. py:attribute:: training_mode - :type: abacusai.api_class.enums.PersonalizationTrainingMode + :type: abacusai.api_class.enums.PersonalizationTrainingMode + .. py:attribute:: target_action_types - :type: List[str] + :type: List[str] + .. py:attribute:: target_action_weights - :type: Dict[str, float] + :type: Dict[str, float] + .. py:attribute:: session_event_types - :type: List[str] + :type: List[str] + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: recent_days_for_training - :type: int + :type: int + .. py:attribute:: training_start_date - :type: str + :type: str + .. py:attribute:: test_on_user_split - :type: bool + :type: bool + .. py:attribute:: test_split_on_last_k_items - :type: bool + :type: bool + .. py:attribute:: test_last_items_length - :type: int + :type: int + .. py:attribute:: test_window_length_hours - :type: int + :type: int + .. py:attribute:: explicit_time_split - :type: bool + :type: bool + .. py:attribute:: test_row_indicator - :type: str + :type: str + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: sequential_training - :type: bool + :type: bool + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: optimized_event_type - :type: str + :type: str + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: disable_transformer - :type: bool + :type: bool + .. py:attribute:: disable_gpu - :type: bool + :type: bool + .. py:attribute:: filter_history - :type: bool + :type: bool + .. py:attribute:: action_types_exclusion_days - :type: Dict[str, float] + :type: Dict[str, float] + .. py:attribute:: max_history_length - :type: int + :type: int + .. py:attribute:: compute_rerank_metrics - :type: bool + :type: bool + .. py:attribute:: add_time_features - :type: bool + :type: bool + .. py:attribute:: disable_timestamp_scalar_features - :type: bool + :type: bool + .. py:attribute:: compute_session_metrics - :type: bool + :type: bool + .. py:attribute:: query_column - :type: str + :type: str + .. py:attribute:: item_query_column - :type: str + :type: str + .. py:attribute:: use_user_id_feature - :type: bool + :type: bool + .. py:attribute:: session_dedupe_mins - :type: float + :type: float + .. py:attribute:: max_user_history_len_percentile - :type: int + :type: int + .. py:attribute:: downsample_item_popularity_percentile - :type: float + :type: float + .. py:attribute:: min_item_history - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: RegressionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the PREDICTIVE_MODELING problem type @@ -485,179 +437,227 @@ Module Contents :type custom_metrics: List[str] :param partial_dependence_analysis: Specify whether to run partial dependence plots for all features or only some features. :type partial_dependence_analysis: PartialDependenceAnalysis - + :param do_masked_language_model_pretraining: Specify whether to run a masked language model unsupervised pretraining step before supervized training in certain supported algorithms which use BERT-like backbones. + :type do_masked_language_model_pretraining: bool .. py:attribute:: objective - :type: abacusai.api_class.enums.RegressionObjective + :type: abacusai.api_class.enums.RegressionObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.RegressionObjective + :type: abacusai.api_class.enums.RegressionObjective + .. py:attribute:: tree_hpo_mode - :type: abacusai.api_class.enums.RegressionTreeHPOMode + :type: abacusai.api_class.enums.RegressionTreeHPOMode + .. py:attribute:: partial_dependence_analysis - :type: abacusai.api_class.enums.PartialDependenceAnalysis + :type: abacusai.api_class.enums.PartialDependenceAnalysis + .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.RegressionTypeOfSplit + :type: abacusai.api_class.enums.RegressionTypeOfSplit + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: disable_test_val_fold - :type: bool + :type: bool + .. py:attribute:: k_fold_cross_validation - :type: bool + :type: bool + .. py:attribute:: num_cv_folds - :type: int + :type: int + .. py:attribute:: timestamp_based_splitting_column - :type: str + :type: str + .. py:attribute:: timestamp_based_splitting_method - :type: abacusai.api_class.enums.RegressionTimeSplitMethod + :type: abacusai.api_class.enums.RegressionTimeSplitMethod + .. py:attribute:: test_splitting_timestamp - :type: str + :type: str + .. py:attribute:: sampling_unit_keys - :type: List[str] + :type: List[str] + .. py:attribute:: test_row_indicator - :type: str + :type: str + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: rebalance_classes - :type: bool + :type: bool + .. py:attribute:: rare_class_augmentation_threshold - :type: float + :type: float + .. py:attribute:: augmentation_strategy - :type: abacusai.api_class.enums.RegressionAugmentationStrategy + :type: abacusai.api_class.enums.RegressionAugmentationStrategy + .. py:attribute:: training_rows_downsample_ratio - :type: float + :type: float + .. py:attribute:: active_labels_column - :type: str + :type: str + .. py:attribute:: min_categorical_count - :type: int + :type: int + .. py:attribute:: sample_weight - :type: str + :type: str + .. py:attribute:: numeric_clipping_percentile - :type: float + :type: float + .. py:attribute:: target_transform - :type: abacusai.api_class.enums.RegressionTargetTransform + :type: abacusai.api_class.enums.RegressionTargetTransform + .. py:attribute:: ignore_datetime_features - :type: bool + :type: bool + .. py:attribute:: max_text_words - :type: int + :type: int + .. py:attribute:: perform_feature_selection - :type: bool + :type: bool + .. py:attribute:: feature_selection_intensity - :type: int + :type: int + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: pretrained_model_name - :type: str + :type: str + .. py:attribute:: is_multilingual - :type: bool + :type: bool + + + .. py:attribute:: do_masked_language_model_pretraining + :type: bool + + .. py:attribute:: loss_function - :type: abacusai.api_class.enums.RegressionLossFunction + :type: abacusai.api_class.enums.RegressionLossFunction + .. py:attribute:: loss_parameters - :type: str + :type: str + .. py:attribute:: target_encode_categoricals - :type: bool + :type: bool + .. py:attribute:: drop_original_categoricals - :type: bool + :type: bool + .. py:attribute:: monotonically_increasing_features - :type: List[str] + :type: List[str] + .. py:attribute:: monotonically_decreasing_features - :type: List[str] + :type: List[str] + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: custom_loss_functions - :type: List[str] + :type: List[str] + .. py:attribute:: custom_metrics - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: ForecastingTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the FORECASTING problem type @@ -784,262 +784,324 @@ Module Contents :type custom_metrics: List[str] :param return_fractional_forecasts: Use this to return fractional forecast values while prediction - .. py:attribute:: prediction_length - :type: int + :type: int + .. py:attribute:: objective - :type: abacusai.api_class.enums.ForecastingObjective + :type: abacusai.api_class.enums.ForecastingObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.ForecastingObjective + :type: abacusai.api_class.enums.ForecastingObjective + .. py:attribute:: forecast_frequency - :type: abacusai.api_class.enums.ForecastingFrequency + :type: abacusai.api_class.enums.ForecastingFrequency + .. py:attribute:: probability_quantiles - :type: List[float] + :type: List[float] + .. py:attribute:: force_prediction_length - :type: bool + :type: bool + .. py:attribute:: filter_items - :type: bool + :type: bool + .. py:attribute:: enable_feature_selection - :type: bool + :type: bool + .. py:attribute:: enable_padding - :type: bool + :type: bool + .. py:attribute:: enable_cold_start - :type: bool + :type: bool + .. py:attribute:: enable_multiple_backtests - :type: bool + :type: bool + .. py:attribute:: num_backtesting_windows - :type: int + :type: int + .. py:attribute:: backtesting_window_step_size - :type: int + :type: int + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: additional_forecast_keys - :type: List[str] + :type: List[str] + .. py:attribute:: experimentation_mode - :type: abacusai.api_class.enums.ExperimentationMode + :type: abacusai.api_class.enums.ExperimentationMode + .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.ForecastingDataSplitType + :type: abacusai.api_class.enums.ForecastingDataSplitType + .. py:attribute:: test_by_item - :type: bool + :type: bool + .. py:attribute:: test_start - :type: str + :type: str + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: loss_function - :type: abacusai.api_class.enums.ForecastingLossFunction + :type: abacusai.api_class.enums.ForecastingLossFunction + .. py:attribute:: underprediction_weight - :type: float + :type: float + .. py:attribute:: disable_networks_without_analytic_quantiles - :type: bool + :type: bool + .. py:attribute:: initial_learning_rate - :type: float + :type: float + .. py:attribute:: l2_regularization_factor - :type: float + :type: float + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: recurrent_layers - :type: int + :type: int + .. py:attribute:: recurrent_units - :type: int + :type: int + .. py:attribute:: convolutional_layers - :type: int + :type: int + .. py:attribute:: convolution_filters - :type: int + :type: int + .. py:attribute:: local_scaling_mode - :type: abacusai.api_class.enums.ForecastingLocalScaling + :type: abacusai.api_class.enums.ForecastingLocalScaling + .. py:attribute:: zero_predictor - :type: bool + :type: bool + .. py:attribute:: skip_missing - :type: bool + :type: bool + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: batch_renormalization - :type: bool + :type: bool + .. py:attribute:: history_length - :type: int + :type: int + .. py:attribute:: prediction_step_size - :type: int + :type: int + .. py:attribute:: training_point_overlap - :type: float + :type: float + .. py:attribute:: max_scale_context - :type: int + :type: int + .. py:attribute:: quantiles_extension_method - :type: abacusai.api_class.enums.ForecastingQuanitlesExtensionMethod + :type: abacusai.api_class.enums.ForecastingQuanitlesExtensionMethod + .. py:attribute:: number_of_samples - :type: int + :type: int + .. py:attribute:: symmetrize_quantiles - :type: bool + :type: bool + .. py:attribute:: use_log_transforms - :type: bool + :type: bool + .. py:attribute:: smooth_history - :type: float + :type: float + .. py:attribute:: local_scale_target - :type: bool + :type: bool + .. py:attribute:: use_clipping - :type: bool + :type: bool + .. py:attribute:: timeseries_weight_column - :type: str + :type: str + .. py:attribute:: item_attributes_weight_column - :type: str + :type: str + .. py:attribute:: use_timeseries_weights_in_objective - :type: bool + :type: bool + .. py:attribute:: use_item_weights_in_objective - :type: bool + :type: bool + .. py:attribute:: skip_timeseries_weight_scaling - :type: bool + :type: bool + .. py:attribute:: timeseries_loss_weight_column - :type: str + :type: str + .. py:attribute:: use_item_id - :type: bool + :type: bool + .. py:attribute:: use_all_item_totals - :type: bool + :type: bool + .. py:attribute:: handle_zeros_as_missing_values - :type: bool + :type: bool + .. py:attribute:: datetime_holiday_calendars - :type: List[abacusai.api_class.enums.HolidayCalendars] + :type: List[abacusai.api_class.enums.HolidayCalendars] + .. py:attribute:: fill_missing_values - :type: List[dict] + :type: List[dict] + .. py:attribute:: enable_clustering - :type: bool + :type: bool + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: custom_loss_functions - :type: List[str] + :type: List[str] + .. py:attribute:: custom_metrics - :type: List[str] + :type: List[str] + .. py:attribute:: return_fractional_forecasts - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NamedEntityExtractionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the NAMED_ENTITY_EXTRACTION problem type @@ -1060,62 +1122,57 @@ Module Contents :param enhanced_ocr: Enhanced text extraction from predicted digital documents :type enhanced_ocr: bool - .. py:attribute:: llm_for_ner - :type: abacusai.api_class.enums.LLMName - :value: None - + :type: abacusai.api_class.enums.LLMName + .. py:attribute:: test_split - :type: int - :value: None - + :type: int + .. py:attribute:: test_row_indicator - :type: str - :value: None - + :type: str + .. py:attribute:: active_labels_column - :type: str - :value: None - + :type: str + .. py:attribute:: document_format - :type: abacusai.api_class.enums.NLPDocumentFormat - :value: None - + :type: abacusai.api_class.enums.NLPDocumentFormat + .. py:attribute:: minimum_bounding_box_overlap_ratio - :type: float + :type: float :value: 0.0 - + .. py:attribute:: save_predicted_pdf - :type: bool + :type: bool :value: True - + .. py:attribute:: enhanced_ocr - :type: bool + :type: bool :value: False - + .. py:method:: __post_init__() + .. py:class:: NaturalLanguageSearchTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the NATURAL_LANGUAGE_SEARCH problem type @@ -1132,38 +1189,44 @@ Module Contents :param index_fraction: Fraction of the chunk to use for indexing. :type index_fraction: float - .. py:attribute:: abacus_internal_model - :type: bool + :type: bool + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: larger_embeddings - :type: bool + :type: bool + .. py:attribute:: search_chunk_size - :type: int + :type: int + .. py:attribute:: index_fraction - :type: float + :type: float + .. py:attribute:: chunk_overlap_fraction - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: ChatLLMTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CHAT_LLM problem type @@ -1211,110 +1274,134 @@ Module Contents :param enable_code_execution: Enable python code execution in the ChatLLM. This equips the LLM with a python kernel in which all its code is executed. :type enable_code_execution: bool - .. py:attribute:: document_retrievers - :type: List[str] + :type: List[str] + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: retrieval_columns - :type: list + :type: list + .. py:attribute:: filter_columns - :type: list + :type: list + .. py:attribute:: include_general_knowledge - :type: bool + :type: bool + .. py:attribute:: enable_web_search - :type: bool + :type: bool + .. py:attribute:: behavior_instructions - :type: str + :type: str + .. py:attribute:: response_instructions - :type: str + :type: str + .. py:attribute:: enable_llm_rewrite - :type: bool + :type: bool + .. py:attribute:: column_filtering_instructions - :type: str + :type: str + .. py:attribute:: keyword_requirement_instructions - :type: str + :type: str + .. py:attribute:: query_rewrite_instructions - :type: str + :type: str + .. py:attribute:: max_search_results - :type: int + :type: int + .. py:attribute:: data_feature_group_ids - :type: List[str] + :type: List[str] + .. py:attribute:: data_prompt_context - :type: str + :type: str + .. py:attribute:: hide_generated_sql - :type: bool + :type: bool + .. py:attribute:: disable_data_summarization - :type: bool + :type: bool + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: database_connector_id - :type: str + :type: str + .. py:attribute:: database_connector_tables - :type: List[str] + :type: List[str] + .. py:attribute:: enable_code_execution - :type: bool + :type: bool + .. py:attribute:: metadata_columns - :type: list + :type: list + .. py:attribute:: lookup_rewrite_instructions - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: SentenceBoundaryDetectionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the SENTENCE_BOUNDARY_DETECTION problem type @@ -1325,26 +1412,29 @@ Module Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: SentimentDetectionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the SENTIMENT_DETECTION problem type @@ -1359,34 +1449,39 @@ Module Contents :param compute_metrics: Whether to compute metrics. :type compute_metrics: bool - .. py:attribute:: sentiment_type - :type: abacusai.api_class.enums.SentimentType + :type: abacusai.api_class.enums.SentimentType + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: compute_metrics - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: DocumentClassificationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_CLASSIFICATION problem type @@ -1399,30 +1494,34 @@ Module Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: zero_shot_hypotheses - :type: List[str] + :type: List[str] + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: DocumentSummarizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_SUMMARIZATION problem type @@ -1433,26 +1532,29 @@ Module Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: DocumentVisualizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_VISUALIZATION problem type @@ -1463,44 +1565,48 @@ Module Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: ClusteringTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CLUSTERING problem type :param num_clusters_selection: Number of clusters. If None, will be selected automatically. :type num_clusters_selection: int - .. py:attribute:: num_clusters_selection - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: ClusteringTimeseriesTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CLUSTERING_TIMESERIES problem type @@ -1509,40 +1615,43 @@ Module Contents :param imputation: Imputation method for missing values. :type imputation: ClusteringImputationMethod - .. py:attribute:: num_clusters_selection - :type: int + :type: int + .. py:attribute:: imputation - :type: abacusai.api_class.enums.ClusteringImputationMethod + :type: abacusai.api_class.enums.ClusteringImputationMethod + .. py:method:: __post_init__() + .. py:class:: EventAnomalyTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the EVENT_ANOMALY problem type :param anomaly_fraction: The fraction of the dataset to classify as anomalous, between 0 and 0.5 :type anomaly_fraction: float - .. py:attribute:: anomaly_fraction - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: TimeseriesAnomalyTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the TS_ANOMALY problem type @@ -1567,54 +1676,64 @@ Module Contents :param threshold_score: Threshold score for anomaly detection :type threshold_score: float - .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.TimeseriesAnomalyDataSplitType + :type: abacusai.api_class.enums.TimeseriesAnomalyDataSplitType + .. py:attribute:: test_start - :type: str + :type: str + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: fill_missing_values - :type: List[dict] + :type: List[dict] + .. py:attribute:: handle_zeros_as_missing_values - :type: bool + :type: bool + .. py:attribute:: timeseries_frequency - :type: str + :type: str + .. py:attribute:: min_samples_in_normal_region - :type: int + :type: int + .. py:attribute:: anomaly_type - :type: abacusai.api_class.enums.TimeseriesAnomalyTypeOfAnomaly + :type: abacusai.api_class.enums.TimeseriesAnomalyTypeOfAnomaly + .. py:attribute:: hyperparameter_calculation_with_heuristics - :type: abacusai.api_class.enums.TimeseriesAnomalyUseHeuristic + :type: abacusai.api_class.enums.TimeseriesAnomalyUseHeuristic + .. py:attribute:: threshold_score - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: CumulativeForecastingTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUMULATIVE_FORECASTING problem type @@ -1631,49 +1750,55 @@ Module Contents :param predict_residuals: Predict residuals instead of totals at each prediction step. :type predict_residuals: bool - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: historical_frequency - :type: str + :type: str + .. py:attribute:: cumulative_prediction_lengths - :type: List[int] + :type: List[int] + .. py:attribute:: skip_input_transform - :type: bool + :type: bool + .. py:attribute:: skip_target_transform - :type: bool + :type: bool + .. py:attribute:: predict_residuals - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ThemeAnalysisTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the THEME ANALYSIS problem type - .. py:method:: __post_init__() + .. py:class:: AIAgentTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the AI_AGENT problem type @@ -1682,34 +1807,39 @@ Module Contents :param agent_interface: The interface that the agent will be deployed with. :type agent_interface: AgentInterface - .. py:attribute:: description - :type: str + :type: str + .. py:attribute:: agent_interface - :type: abacusai.api_class.enums.AgentInterface + :type: abacusai.api_class.enums.AgentInterface + .. py:attribute:: enable_binary_input - :type: bool + :type: bool + .. py:attribute:: agent_input_schema - :type: dict + :type: dict + .. py:attribute:: agent_output_schema - :type: dict + :type: dict + .. py:method:: __post_init__() + .. py:class:: CustomTrainedModelTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUSTOM_TRAINED_MODEL problem type @@ -1726,56 +1856,63 @@ Module Contents :param streaming_embeddings: Flag to enable streaming embeddings. :type streaming_embeddings: bool - .. py:attribute:: max_catalog_size - :type: int + :type: int + .. py:attribute:: max_dimension - :type: int + :type: int + .. py:attribute:: index_output_path - :type: str + :type: str + .. py:attribute:: docker_image_uri - :type: str + :type: str + .. py:attribute:: service_port - :type: int + :type: int + .. py:attribute:: streaming_embeddings - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: CustomAlgorithmTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUSTOM_ALGORITHM problem type :param timeout_minutes: Timeout for the model training in minutes. :type timeout_minutes: int - .. py:attribute:: timeout_minutes - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: OptimizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the OPTIMIZATION problem type @@ -1784,42 +1921,46 @@ Module Contents :param optimality_gap_limit: The stopping optimality gap limit. Optimality gap is fractional difference between the best known solution and the best possible solution. Accepts values between 0 and 1. :type optimality_gap_limit: float - .. py:attribute:: solve_time_limit - :type: float + :type: float + .. py:attribute:: optimality_gap_limit - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: _TrainingConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + .. py:class:: DeployableAlgorithm - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Algorithm that can be deployed to a model. @@ -1832,20 +1973,24 @@ Module Contents :param trained_model_types: List of trained model types. :type trained_model_types: List[dict] - .. py:attribute:: algorithm - :type: str + :type: str + .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: only_offline_deployable - :type: bool + :type: bool + .. py:attribute:: trained_model_types - :type: List[dict] + :type: List[dict] + + diff --git a/docs/_sources/autoapi/abacusai/api_class/monitor/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/monitor/index.rst.txt index 82f51c2ce..c7affb4a9 100644 --- a/docs/_sources/autoapi/abacusai/api_class/monitor/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/monitor/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.monitor -========================== +:py:mod:`abacusai.api_class.monitor` +==================================== .. py:module:: abacusai.api_class.monitor +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.monitor.ApiClass - abacusai.api_class.monitor.StdDevThresholdType abacusai.api_class.monitor.TimeWindowConfig abacusai.api_class.monitor.ForecastingMonitorConfig abacusai.api_class.monitor.StdDevThreshold @@ -19,100 +20,12 @@ Classes abacusai.api_class.monitor.MonitorFilteringConfig -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: StdDevThresholdType - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: ABSOLUTE - :value: 'ABSOLUTE' - - - - .. py:attribute:: PERCENTILE - :value: 'PERCENTILE' - - - - .. py:attribute:: STDDEV - :value: 'STDDEV' - .. py:class:: TimeWindowConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Time Window Configuration @@ -121,14 +34,15 @@ Module Contents :param window_from_start: Whether the window should be from the start of the time series. :type window_from_start: bool - .. py:attribute:: window_duration - :type: int + :type: int + .. py:attribute:: window_from_start - :type: bool + :type: bool + .. py:method:: to_dict() @@ -140,8 +54,8 @@ Module Contents .. py:class:: ForecastingMonitorConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Forecasting Monitor Configuration @@ -158,30 +72,35 @@ Module Contents :param window_config: The windowing configuration for the time series data. :type window_config: TimeWindowConfig - .. py:attribute:: id_column - :type: str + :type: str + .. py:attribute:: timestamp_column - :type: str + :type: str + .. py:attribute:: target_column - :type: str + :type: str + .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: window_config - :type: TimeWindowConfig + :type: TimeWindowConfig + .. py:method:: to_dict() @@ -193,8 +112,8 @@ Module Contents .. py:class:: StdDevThreshold - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Std Dev Threshold types @@ -203,14 +122,15 @@ Module Contents :param value: Value to use for the threshold. :type value: float - .. py:attribute:: threshold_type - :type: abacusai.api_class.enums.StdDevThresholdType + :type: abacusai.api_class.enums.StdDevThresholdType + .. py:attribute:: value - :type: float + :type: float + .. py:method:: to_dict() @@ -222,8 +142,8 @@ Module Contents .. py:class:: ItemAttributesStdDevThreshold - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Item Attributes Std Dev Threshold for Monitor Alerts @@ -232,14 +152,15 @@ Module Contents :param upper_bound: Upper bound for the item attributes. :type upper_bound: StdDevThreshold - .. py:attribute:: lower_bound - :type: StdDevThreshold + :type: StdDevThreshold + .. py:attribute:: upper_bound - :type: StdDevThreshold + :type: StdDevThreshold + .. py:method:: to_dict() @@ -251,8 +172,8 @@ Module Contents .. py:class:: RestrictFeatureMappings - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Restrict Feature Mappings for Monitor Filtering @@ -269,30 +190,35 @@ Module Contents :param max_value: Filtering the numerical feature to below this value :type max_value: float - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: restricted_feature_values - :type: list + :type: list + .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: min_value - :type: float + :type: float + .. py:attribute:: max_value - :type: float + :type: float + .. py:method:: to_dict() @@ -304,8 +230,8 @@ Module Contents .. py:class:: MonitorFilteringConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Monitor Filtering Configuration @@ -322,30 +248,35 @@ Module Contents :param prediction_target_feature: Set the target feature for the prediction data. :type prediction_target_feature: str - .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: restrict_feature_mappings - :type: List[RestrictFeatureMappings] + :type: List[RestrictFeatureMappings] + .. py:attribute:: target_class - :type: str + :type: str + .. py:attribute:: train_target_feature - :type: str + :type: str + .. py:attribute:: prediction_target_feature - :type: str + :type: str + .. py:method:: to_dict() diff --git a/docs/_sources/autoapi/abacusai/api_class/monitor_alert/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/monitor_alert/index.rst.txt index 00c8a64f0..0284e8212 100644 --- a/docs/_sources/autoapi/abacusai/api_class/monitor_alert/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/monitor_alert/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.monitor_alert -================================ +:py:mod:`abacusai.api_class.monitor_alert` +========================================== .. py:module:: abacusai.api_class.monitor_alert +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.monitor_alert.ApiClass - abacusai.api_class.monitor_alert._ApiClassFactory abacusai.api_class.monitor_alert.AlertConditionConfig abacusai.api_class.monitor_alert.AccuracyBelowThresholdConditionConfig abacusai.api_class.monitor_alert.FeatureDriftConditionConfig @@ -26,109 +27,19 @@ Classes abacusai.api_class.monitor_alert.MonitorThresholdConfig -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - .. py:class:: AlertConditionConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for alert condition configs - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType + :type: abacusai.api_class.enums.MonitorAlertType + .. py:method:: _get_builder() :classmethod: @@ -137,26 +48,27 @@ Module Contents .. py:class:: AccuracyBelowThresholdConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Accuracy Below Threshold Condition Config for Monitor Alerts :param threshold: Threshold for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: FeatureDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Feature Drift Condition Config for Monitor Alerts @@ -169,30 +81,34 @@ Module Contents :param feature_names: List of feature names to monitor for this alert. :type feature_names: List[str] - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:attribute:: feature_names - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: TargetDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Target Drift Condition Config for Monitor Alerts @@ -201,22 +117,24 @@ Module Contents :param threshold: Threshold for when to consider the target column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: HistoryLengthDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` History Length Drift Condition Config for Monitor Alerts @@ -225,22 +143,24 @@ Module Contents :param threshold: Threshold for when to consider the history length to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: DataIntegrityViolationConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Data Integrity Violation Condition Config for Monitor Alerts @@ -249,22 +169,24 @@ Module Contents :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int - .. py:attribute:: data_integrity_type - :type: abacusai.api_class.enums.DataIntegrityViolationType + :type: abacusai.api_class.enums.DataIntegrityViolationType + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: BiasViolationConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Bias Violation Condition Config for Monitor Alerts @@ -275,26 +197,29 @@ Module Contents :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int - .. py:attribute:: bias_type - :type: abacusai.api_class.enums.BiasType + :type: abacusai.api_class.enums.BiasType + .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: PredictionCountConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Deployment Prediction Condition Config for Deployment Alerts. By default we monitor if predictions made over a time window has reduced significantly. :param threshold: Threshold for when to consider to be a violation. Negative means alert on reduction, positive means alert on increase. @@ -304,58 +229,63 @@ Module Contents :param aggregation_type: Aggregation type to use for the aggregation window, e.g. sum, avg. :type aggregation_type: str - .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: aggregation_window - :type: str + :type: str + .. py:attribute:: aggregation_type - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _AlertConditionConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'alert_type' - + .. py:attribute:: config_class_key_value_camel_case :value: True - + .. py:attribute:: config_class_map + + .. py:class:: AlertActionConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for alert action configs - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType + :type: abacusai.api_class.enums.AlertActionType + .. py:method:: _get_builder() :classmethod: @@ -364,8 +294,8 @@ Module Contents .. py:class:: EmailActionConfig - Bases: :py:obj:`AlertActionConfig` + Bases: :py:obj:`AlertActionConfig` Email Action Config for Monitor Alerts @@ -374,42 +304,46 @@ Module Contents :param email_body: Body of the email to send. :type email_body: str - .. py:attribute:: email_recipients - :type: List[str] + :type: List[str] + .. py:attribute:: email_body - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _AlertActionConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'action_type' - + .. py:attribute:: config_class_map + + .. py:class:: MonitorThresholdConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Monitor Threshold Config for Monitor Alerts @@ -418,18 +352,20 @@ Module Contents :param threshold_config: Thresholds for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold_config: ThresholdConfigs - .. py:attribute:: drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: at_risk_threshold - :type: float + :type: float + .. py:attribute:: severely_drifting_threshold - :type: float + :type: float + .. py:method:: to_dict() diff --git a/docs/_sources/autoapi/abacusai/api_class/project/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/project/index.rst.txt index b9707e209..17487fb53 100644 --- a/docs/_sources/autoapi/abacusai/api_class/project/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/project/index.rst.txt @@ -1,16 +1,17 @@ -abacusai.api_class.project -========================== +:py:mod:`abacusai.api_class.project` +==================================== .. py:module:: abacusai.api_class.project +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.project.ApiClass - abacusai.api_class.project._ApiClassFactory abacusai.api_class.project.FeatureMappingConfig abacusai.api_class.project.ProjectFeatureGroupTypeMappingsConfig abacusai.api_class.project.ConstraintConfig @@ -20,102 +21,12 @@ Classes abacusai.api_class.project._ProjectFeatureGroupConfigFactory -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - .. py:class:: FeatureMappingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Feature mapping configuration for a feature group type. @@ -126,23 +37,26 @@ Module Contents :param nested_feature_name: The name of the nested feature in the feature group. :type nested_feature_name: str - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: feature_mapping - :type: str + :type: str + .. py:attribute:: nested_feature_name - :type: str + :type: str + + .. py:class:: ProjectFeatureGroupTypeMappingsConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Project feature group type mappings. @@ -153,18 +67,20 @@ Module Contents :param feature_mappings: The feature mappings for the feature group. :type feature_mappings: List[FeatureMappingConfig] - .. py:attribute:: feature_group_id - :type: str + :type: str + .. py:attribute:: feature_group_type - :type: str + :type: str + .. py:attribute:: feature_mappings - :type: List[FeatureMappingConfig] + :type: List[FeatureMappingConfig] + .. py:method:: from_dict(input_dict) :classmethod: @@ -173,8 +89,8 @@ Module Contents .. py:class:: ConstraintConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Constraint configuration. @@ -189,38 +105,43 @@ Module Contents :param penalty: The penalty for violating the constraint. :type penalty: float - .. py:attribute:: constant - :type: float + :type: float + .. py:attribute:: operator - :type: str + :type: str + .. py:attribute:: enforcement - :type: Optional[str] + :type: Optional[str] + .. py:attribute:: code - :type: Optional[str] + :type: Optional[str] + .. py:attribute:: penalty - :type: Optional[float] + :type: Optional[float] + + .. py:class:: ProjectFeatureGroupConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for project feature group configuration. - .. py:attribute:: type - :type: abacusai.api_class.enums.ProjectConfigType + :type: abacusai.api_class.enums.ProjectConfigType + .. py:method:: _get_builder() :classmethod: @@ -229,57 +150,61 @@ Module Contents .. py:class:: ConstraintProjectFeatureGroupConfig - Bases: :py:obj:`ProjectFeatureGroupConfig` + Bases: :py:obj:`ProjectFeatureGroupConfig` Constraint project feature group configuration. :param constraints: The constraint for the feature group. Should be a list of one ConstraintConfig. :type constraints: List[ConstraintConfig] - .. py:attribute:: constraints - :type: List[ConstraintConfig] + :type: List[ConstraintConfig] + .. py:method:: __post_init__() + .. py:class:: ReviewModeProjectFeatureGroupConfig - Bases: :py:obj:`ProjectFeatureGroupConfig` + Bases: :py:obj:`ProjectFeatureGroupConfig` Review mode project feature group configuration. :param is_review_mode: The review mode for the feature group. :type is_review_mode: bool - .. py:attribute:: is_review_mode - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _ProjectFeatureGroupConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_class/python_functions/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/python_functions/index.rst.txt index 25035a7d3..f799a9d1e 100644 --- a/docs/_sources/autoapi/abacusai/api_class/python_functions/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/python_functions/index.rst.txt @@ -1,88 +1,27 @@ -abacusai.api_class.python_functions -=================================== +:py:mod:`abacusai.api_class.python_functions` +============================================= .. py:module:: abacusai.api_class.python_functions +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.python_functions.ApiClass abacusai.api_class.python_functions.PythonFunctionArgument abacusai.api_class.python_functions.OutputVariableMapping -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - .. py:class:: PythonFunctionArgument - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for python function arguments @@ -97,31 +36,36 @@ Module Contents :param pipeline_variable: The name of the pipeline variable to use as the value :type pipeline_variable: str - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionArgumentType + :type: abacusai.api_class.enums.PythonFunctionArgumentType + .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: is_required - :type: bool + :type: bool + .. py:attribute:: value - :type: Any + :type: Any + .. py:attribute:: pipeline_variable - :type: str + :type: str + + .. py:class:: OutputVariableMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for python function arguments @@ -130,12 +74,14 @@ Module Contents :param name: The name of the python function variable :type name: str - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionOutputArgumentType + :type: abacusai.api_class.enums.PythonFunctionOutputArgumentType + .. py:attribute:: name - :type: str + :type: str + + diff --git a/docs/_sources/autoapi/abacusai/api_class/refresh/index.rst.txt b/docs/_sources/autoapi/abacusai/api_class/refresh/index.rst.txt index e31c54dc7..047f3cbde 100644 --- a/docs/_sources/autoapi/abacusai/api_class/refresh/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_class/refresh/index.rst.txt @@ -1,125 +1,36 @@ -abacusai.api_class.refresh -========================== +:py:mod:`abacusai.api_class.refresh` +==================================== .. py:module:: abacusai.api_class.refresh +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: - abacusai.api_class.refresh.ApiClass - abacusai.api_class.refresh._ApiClassFactory abacusai.api_class.refresh.FeatureGroupExportConfig abacusai.api_class.refresh.FileConnectorExportConfig abacusai.api_class.refresh.DatabaseConnectorExportConfig abacusai.api_class.refresh._FeatureGroupExportConfigFactory -Module Contents ---------------- - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: _ApiClassFactory - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: config_abstract_class - :value: None - - - - .. py:attribute:: config_class_key - :value: None - - - - .. py:attribute:: config_class_map - - - .. py:method:: from_dict(config) - :classmethod: - .. py:class:: FeatureGroupExportConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for feature group exports. - .. py:attribute:: connector_type - :type: abacusai.api_class.enums.ConnectorType + :type: abacusai.api_class.enums.ConnectorType + .. py:method:: _get_builder() :classmethod: @@ -128,8 +39,8 @@ Module Contents .. py:class:: FileConnectorExportConfig - Bases: :py:obj:`FeatureGroupExportConfig` + Bases: :py:obj:`FeatureGroupExportConfig` File connector export config for feature groups @@ -138,14 +49,15 @@ Module Contents :param export_file_format: The file format to export the feature group to :type export_file_format: str - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: export_file_format - :type: str + :type: str + .. py:method:: __post_init__() @@ -160,8 +72,8 @@ Module Contents .. py:class:: DatabaseConnectorExportConfig - Bases: :py:obj:`FeatureGroupExportConfig` + Bases: :py:obj:`FeatureGroupExportConfig` Database connector export config for feature groups @@ -178,30 +90,35 @@ Module Contents :param data_columns: The data columns to export the feature group to :type data_columns: Dict[str, str] - .. py:attribute:: database_connector_id - :type: str + :type: str + .. py:attribute:: mode - :type: str + :type: str + .. py:attribute:: object_name - :type: str + :type: str + .. py:attribute:: id_column - :type: str + :type: str + .. py:attribute:: additional_id_columns - :type: List[str] + :type: List[str] + .. py:attribute:: data_columns - :type: Dict[str, str] + :type: Dict[str, str] + .. py:method:: __post_init__() @@ -216,21 +133,23 @@ Module Contents .. py:class:: _FeatureGroupExportConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'connector_type' - + .. py:attribute:: config_class_map + + diff --git a/docs/_sources/autoapi/abacusai/api_client_utils/index.rst.txt b/docs/_sources/autoapi/abacusai/api_client_utils/index.rst.txt index c461994d7..b2910ec09 100644 --- a/docs/_sources/autoapi/abacusai/api_client_utils/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_client_utils/index.rst.txt @@ -1,19 +1,14 @@ -abacusai.api_client_utils -========================= +:py:mod:`abacusai.api_client_utils` +=================================== .. py:module:: abacusai.api_client_utils -Attributes ----------- - -.. autoapisummary:: - - abacusai.api_client_utils.INVALID_PANDAS_COLUMN_NAME_CHARACTERS - +Module Contents +--------------- Classes -------- +~~~~~~~ .. autoapisummary:: @@ -22,8 +17,9 @@ Classes abacusai.api_client_utils.DocstoreUtils + Functions ---------- +~~~~~~~~~ .. autoapisummary:: @@ -36,23 +32,33 @@ Functions abacusai.api_client_utils.try_abacus_internal_copy -Module Contents ---------------- + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + abacusai.api_client_utils.INVALID_PANDAS_COLUMN_NAME_CHARACTERS + .. py:data:: INVALID_PANDAS_COLUMN_NAME_CHARACTERS :value: '[^A-Za-z0-9_]' + .. py:function:: clean_column_name(column) + .. py:function:: avro_to_pandas_dtype(avro_type) + .. py:function:: get_non_nullable_type(types) + .. py:class:: StreamingHandler - Bases: :py:obj:`str` + Bases: :py:obj:`str` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str @@ -65,7 +71,6 @@ Module Contents encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'. - .. py:method:: process_streaming_data(value, context, section_key, data_type) :classmethod: @@ -73,136 +78,135 @@ Module Contents .. py:function:: get_object_from_context(client, context, variable_name, return_type) + .. py:function:: load_as_pandas_from_avro_fd(fd) + .. py:function:: load_as_pandas_from_avro_files(files, download_method, max_workers = 10) + .. py:class:: StreamType - Bases: :py:obj:`enum.Enum` + Bases: :py:obj:`enum.Enum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: MESSAGE :value: 'message' - + .. py:attribute:: SECTION_OUTPUT :value: 'section_output' + .. py:class:: DocstoreUtils + Utility class for loading docstore data. Needs to be updated if docstore formats change. - .. py:attribute:: DOC_ID :value: 'doc_id' - + .. py:attribute:: PREDICTION_PREFIX :value: 'prediction' - + .. py:attribute:: FIRST_PAGE :value: 'first_page' - + .. py:attribute:: LAST_PAGE :value: 'last_page' - + .. py:attribute:: PAGE_TEXT :value: 'page_text' - + .. py:attribute:: PAGES :value: 'pages' - + .. py:attribute:: CONTENT :value: 'content' - + .. py:attribute:: TOKENS :value: 'tokens' - + .. py:attribute:: PAGES_ZIP_METADATA :value: 'pages_zip_metadata' - + .. py:attribute:: PAGE_DATA :value: 'page_data' - + .. py:attribute:: HEIGHT :value: 'height' - + .. py:attribute:: WIDTH :value: 'width' - + .. py:attribute:: METADATA :value: 'metadata' - + .. py:attribute:: EXTRACTED_TEXT :value: 'extracted_text' - + .. py:attribute:: DOCUMENT_PROCESSING_CONFIG :value: 'document_processing_config' - + .. py:attribute:: DOCUMENT_PROCESSING_VERSION :value: 'document_processing_version' - + .. py:method:: get_archive_id(doc_id) :staticmethod: - .. py:method:: get_page_id(doc_id, page) :staticmethod: - .. py:method:: get_content_hash(doc_id) :staticmethod: - .. py:method:: get_pandas_pages_df(df, feature_group_version, doc_id_column, document_column, get_docstore_resource_bytes, get_document_processing_result_infos, max_workers = 10) :classmethod: - .. py:method:: get_pandas_documents_df(df, feature_group_version, doc_id_column, document_column, get_docstore_resource_bytes, get_document_processing_result_infos, max_workers = 10) :classmethod: diff --git a/docs/_sources/autoapi/abacusai/api_endpoint/index.rst.txt b/docs/_sources/autoapi/abacusai/api_endpoint/index.rst.txt index 1f100dd64..dfefbe55d 100644 --- a/docs/_sources/autoapi/abacusai/api_endpoint/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_endpoint/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.api_endpoint -===================== +:py:mod:`abacusai.api_endpoint` +=============================== .. py:module:: abacusai.api_endpoint -Classes -------- - -.. autoapisummary:: - - abacusai.api_endpoint.AbstractApiClass - abacusai.api_endpoint.ApiEndpoint - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.api_endpoint.ApiEndpoint - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ApiEndpoint(client, apiEndpoint=None, predictEndpoint=None, proxyEndpoint=None, llmEndpoint=None, externalChatEndpoint=None, dashboardEndpoint=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An collection of endpoints which can be used to make requests to, such as api calls or predict calls @@ -49,13 +39,11 @@ Module Contents :param dashboardEndpoint: The URI that the external chat will use to go back to the dashboard :type dashboardEndpoint: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/api_key/index.rst.txt b/docs/_sources/autoapi/abacusai/api_key/index.rst.txt index bda6f77d0..8eae8e701 100644 --- a/docs/_sources/autoapi/abacusai/api_key/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/api_key/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.api_key -================ +:py:mod:`abacusai.api_key` +========================== .. py:module:: abacusai.api_key -Classes -------- - -.. autoapisummary:: - - abacusai.api_key.AbstractApiClass - abacusai.api_key.ApiKey - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.api_key.ApiKey - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ApiKey(client, apiKeyId=None, apiKey=None, tag=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An API Key to authenticate requests to the Abacus.AI API @@ -45,13 +35,11 @@ Module Contents :param createdAt: The timestamp when the API key was created. :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -60,7 +48,6 @@ Module Contents :rtype: dict - .. py:method:: delete() Delete a specified API key. diff --git a/docs/_sources/autoapi/abacusai/app_user_group/index.rst.txt b/docs/_sources/autoapi/abacusai/app_user_group/index.rst.txt index f248458a5..17138a709 100644 --- a/docs/_sources/autoapi/abacusai/app_user_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/app_user_group/index.rst.txt @@ -1,73 +1,26 @@ -abacusai.app_user_group -======================= +:py:mod:`abacusai.app_user_group` +================================= .. py:module:: abacusai.app_user_group -Classes -------- - -.. autoapisummary:: - - abacusai.app_user_group.AbstractApiClass - abacusai.app_user_group.User - abacusai.app_user_group.AppUserGroup - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: _get_attribute_as_dict(attribute) - - -.. py:class:: User(client, name=None, email=None, createdAt=None, status=None, organizationGroups={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Abacus.AI User - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The User's name. - :type name: str - :param email: The User's primary email address. - :type email: str - :param createdAt: The date and time when the user joined Abacus.AI. - :type createdAt: str - :param status: `ACTIVE` when the user has accepted an invite to join the organization, else `INVITED`. - :type status: str - :param organizationGroups: List of Organization Groups this user belongs to. - :type organizationGroups: OrganizationGroup - - - .. py:method:: __repr__() - - Return repr(self). - - +Classes +~~~~~~~ - .. py:method:: to_dict() +.. autoapisummary:: - Get a dict representation of the parameters in this class + abacusai.app_user_group.AppUserGroup - :returns: The dict value representation of the class parameters - :rtype: dict .. py:class:: AppUserGroup(client, name=None, userGroupId=None, externalApplicationIds=None, invitedUserEmails=None, publicUserGroup=None, hasExternalApplicationReporting=None, isExternalServiceGroup=None, externalServiceGroupId=None, users={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An app user group. This is used to determine which users have permissions for external chatbots. @@ -92,13 +45,11 @@ Module Contents :param users: The users in the user group. :type users: User - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/application_connector/index.rst.txt b/docs/_sources/autoapi/abacusai/application_connector/index.rst.txt index 313eeb989..7d03402aa 100644 --- a/docs/_sources/autoapi/abacusai/application_connector/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/application_connector/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.application_connector -============================== +:py:mod:`abacusai.application_connector` +======================================== .. py:module:: abacusai.application_connector -Classes -------- - -.. autoapisummary:: - - abacusai.application_connector.AbstractApiClass - abacusai.application_connector.ApplicationConnector - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.application_connector.ApplicationConnector - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ApplicationConnector(client, applicationConnectorId=None, service=None, name=None, createdAt=None, status=None, auth=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A connector to an external service @@ -49,13 +39,11 @@ Module Contents :param auth: Non-secret connection information for this connector :type auth: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -64,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: rename(name) Renames a Application Connector @@ -73,7 +60,6 @@ Module Contents :type name: str - .. py:method:: delete() Delete an application connector. @@ -82,7 +68,6 @@ Module Contents :type application_connector_id: str - .. py:method:: list_objects() Lists querable objects in the application connector. @@ -91,7 +76,6 @@ Module Contents :type application_connector_id: str - .. py:method:: verify() Checks if Abacus.AI can access the application using the provided application connector ID. diff --git a/docs/_sources/autoapi/abacusai/batch_prediction/index.rst.txt b/docs/_sources/autoapi/abacusai/batch_prediction/index.rst.txt index 3f4c23311..f13b0ab03 100644 --- a/docs/_sources/autoapi/abacusai/batch_prediction/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/batch_prediction/index.rst.txt @@ -1,378 +1,26 @@ -abacusai.batch_prediction -========================= +:py:mod:`abacusai.batch_prediction` +=================================== .. py:module:: abacusai.batch_prediction -Classes -------- - -.. autoapisummary:: - - abacusai.batch_prediction.BatchPredictionArgs - abacusai.batch_prediction.BatchPredictionVersion - abacusai.batch_prediction.PredictionFeatureGroup - abacusai.batch_prediction.PredictionInput - abacusai.batch_prediction.RefreshSchedule - abacusai.batch_prediction.AbstractApiClass - abacusai.batch_prediction.BatchPrediction - - Module Contents --------------- -.. py:class:: BatchPredictionArgs - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for Batch Prediction args specific to problem type. - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: BatchPredictionVersion(client, batchPredictionVersion=None, batchPredictionId=None, status=None, driftMonitorStatus=None, deploymentId=None, modelId=None, modelVersion=None, predictionsStartedAt=None, predictionsCompletedAt=None, databaseOutputError=None, totalPredictions=None, failedPredictions=None, databaseConnectorId=None, databaseOutputConfiguration=None, fileConnectorOutputLocation=None, fileOutputFormat=None, connectorType=None, legacyInputLocation=None, error=None, driftMonitorError=None, monitorWarnings=None, csvInputPrefix=None, csvPredictionPrefix=None, csvExplanationsPrefix=None, databaseOutputTotalWrites=None, databaseOutputFailedWrites=None, outputIncludesMetadata=None, resultInputColumns=None, modelMonitorVersion=None, algoName=None, algorithm=None, outputFeatureGroupId=None, outputFeatureGroupVersion=None, outputFeatureGroupTableName=None, batchPredictionWarnings=None, bpAcrossVersionsMonitorVersion=None, batchPredictionArgsType=None, batchInputs={}, inputFeatureGroups={}, globalPredictionArgs={}, batchPredictionArgs={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch Prediction Version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param batchPredictionVersion: The unique identifier of the batch prediction version - :type batchPredictionVersion: str - :param batchPredictionId: The unique identifier of the batch prediction - :type batchPredictionId: str - :param status: The current status of the batch prediction - :type status: str - :param driftMonitorStatus: The status of the drift monitor for this batch prediction version - :type driftMonitorStatus: str - :param deploymentId: The deployment used to make the predictions - :type deploymentId: str - :param modelId: The model used to make the predictions - :type modelId: str - :param modelVersion: The model version used to make the predictions - :type modelVersion: str - :param predictionsStartedAt: Predictions start date and time - :type predictionsStartedAt: str - :param predictionsCompletedAt: Predictions completion date and time - :type predictionsCompletedAt: str - :param databaseOutputError: If true, there were errors reported by the database connector while writing - :type databaseOutputError: bool - :param totalPredictions: Number of predictions performed in this batch prediction job - :type totalPredictions: int - :param failedPredictions: Number of predictions that failed - :type failedPredictions: int - :param databaseConnectorId: The database connector to write the results to - :type databaseConnectorId: str - :param databaseOutputConfiguration: Contains information about where the batch predictions are written to - :type databaseOutputConfiguration: dict - :param fileConnectorOutputLocation: Contains information about where the batch predictions are written to - :type fileConnectorOutputLocation: str - :param fileOutputFormat: The format of the batch prediction output (CSV or JSON) - :type fileOutputFormat: str - :param connectorType: Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR - :type connectorType: str - :param legacyInputLocation: The location of the input data - :type legacyInputLocation: str - :param error: Relevant error if the status is FAILED - :type error: str - :param driftMonitorError: Error message for the drift monitor of this batch predcition - :type driftMonitorError: str - :param monitorWarnings: Relevant warning if there are issues found in drift or data integrity - :type monitorWarnings: str - :param csvInputPrefix: A prefix to prepend to the input columns, only applies when output format is CSV - :type csvInputPrefix: str - :param csvPredictionPrefix: A prefix to prepend to the prediction columns, only applies when output format is CSV - :type csvPredictionPrefix: str - :param csvExplanationsPrefix: A prefix to prepend to the explanation columns, only applies when output format is CSV - :type csvExplanationsPrefix: str - :param databaseOutputTotalWrites: The total number of rows attempted to write (may be less than total_predictions if write mode is UPSERT and multiple rows share the same ID) - :type databaseOutputTotalWrites: int - :param databaseOutputFailedWrites: The number of failed writes to the Database Connector - :type databaseOutputFailedWrites: int - :param outputIncludesMetadata: If true, output will contain columns including prediction start time, batch prediction version, and model version - :type outputIncludesMetadata: bool - :param resultInputColumns: If present, will limit result files or feature groups to only include columns present in this list - :type resultInputColumns: list[str] - :param modelMonitorVersion: The version of the model monitor - :type modelMonitorVersion: str - :param algoName: The name of the algorithm used to train the model - :type algoName: str - :param algorithm: The algorithm that is currently deployed. - :type algorithm: str - :param outputFeatureGroupId: The Batch Prediction output feature group ID if applicable - :type outputFeatureGroupId: str - :param outputFeatureGroupVersion: The Batch Prediction output feature group version if applicable - :type outputFeatureGroupVersion: str - :param outputFeatureGroupTableName: The Batch Prediction output feature group name if applicable - :type outputFeatureGroupTableName: str - :param batchPredictionWarnings: Relevant warnings if any issues are found - :type batchPredictionWarnings: str - :param bpAcrossVersionsMonitorVersion: The version of the batch prediction across versions monitor - :type bpAcrossVersionsMonitorVersion: str - :param batchPredictionArgsType: The type of the batch prediction args - :type batchPredictionArgsType: str - :param batchInputs: Inputs to the batch prediction - :type batchInputs: PredictionInput - :param inputFeatureGroups: List of prediction feature groups - :type inputFeatureGroups: PredictionFeatureGroup - :param globalPredictionArgs: - :type globalPredictionArgs: BatchPredictionArgs - :param batchPredictionArgs: Argument(s) passed to every prediction call - :type batchPredictionArgs: BatchPredictionArgs - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: download_batch_prediction_result_chunk(offset = 0, chunk_size = 10485760) - - Returns a stream containing the batch prediction results. - - :param offset: The offset to read from. - :type offset: int - :param chunk_size: The maximum amount of data to read. - :type chunk_size: int - - - - .. py:method:: get_batch_prediction_connector_errors() - - Returns a stream containing the batch prediction database connection write errors, if any writes failed for the specified batch prediction job. - - :param batch_prediction_version: Unique string identifier of the batch prediction job to get the errors for. - :type batch_prediction_version: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: BatchPredictionVersion - - - - .. py:method:: describe() - - Describes a Batch Prediction Version. - - :param batch_prediction_version: Unique string identifier of the Batch Prediction Version. - :type batch_prediction_version: str - - :returns: The Batch Prediction Version. - :rtype: BatchPredictionVersion - - - - .. py:method:: get_logs() - - Retrieves the batch prediction logs. - - :param batch_prediction_version: The unique version ID of the batch prediction version. - :type batch_prediction_version: str - - :returns: The logs for the specified batch prediction version. - :rtype: BatchPredictionVersionLogs - - - - .. py:method:: download_result_to_file(file) - - Downloads the batch prediction version in a local file. - - :param file: A file object opened in a binary mode e.g., file=open('/tmp/output', 'wb'). - :type file: file object - - - - .. py:method:: wait_for_predictions(timeout=86400) - - A waiting call until batch prediction version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_drift_monitor(timeout=86400) - - A waiting call until batch prediction drift monitor calculations are ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status(drift_monitor_status = False) - - Gets the status of the batch prediction version. - - :returns: A string describing the status of the batch prediction version, for e.g., pending, complete, etc. - :rtype: str - - - - .. py:method:: load_results_as_pandas() - - Loads the output feature groups into a python pandas dataframe. - - :returns: A pandas dataframe with annotations and text_snippet columns. - :rtype: DataFrame - - - -.. py:class:: PredictionFeatureGroup(client, featureGroupId=None, featureGroupVersion=None, datasetType=None, default=None, required=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch Input Feature Group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The unique identifier of the feature group - :type featureGroupId: str - :param featureGroupVersion: The unique identifier of the feature group version used for predictions - :type featureGroupVersion: str - :param datasetType: dataset type - :type datasetType: str - :param default: If true, this feature group is the default feature group in the model - :type default: bool - :param required: If true, this feature group is required for the batch prediction - :type required: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PredictionInput(client, featureGroupDatasetIds=None, datasetIdRemap=None, featureGroups={}, datasets={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch inputs - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupDatasetIds: The list of dataset IDs to use as input - :type featureGroupDatasetIds: list - :param datasetIdRemap: Replacement datasets to swap as prediction input - :type datasetIdRemap: dict - :param featureGroups: List of prediction feature groups - :type featureGroups: PredictionFeatureGroup - :param datasets: List of prediction datasets - :type datasets: PredictionDataset - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.batch_prediction.BatchPrediction - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: BatchPrediction(client, batchPredictionId=None, createdAt=None, name=None, deploymentId=None, fileConnectorOutputLocation=None, databaseConnectorId=None, databaseOutputConfiguration=None, fileOutputFormat=None, connectorType=None, legacyInputLocation=None, outputFeatureGroupId=None, featureGroupTableName=None, outputFeatureGroupTableName=None, summaryFeatureGroupTableName=None, csvInputPrefix=None, csvPredictionPrefix=None, csvExplanationsPrefix=None, outputIncludesMetadata=None, resultInputColumns=None, modelMonitorId=None, modelVersion=None, bpAcrossVersionsMonitorId=None, algorithm=None, batchPredictionArgsType=None, batchInputs={}, latestBatchPredictionVersion={}, refreshSchedules={}, inputFeatureGroups={}, globalPredictionArgs={}, batchPredictionArgs={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Make batch predictions. @@ -439,13 +87,11 @@ Module Contents :param batchPredictionArgs: Argument(s) passed to every prediction call. :type batchPredictionArgs: BatchPredictionArgs - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -454,7 +100,6 @@ Module Contents :rtype: dict - .. py:method:: start() Creates a new batch prediction version job for a given batch prediction job description. @@ -466,7 +111,6 @@ Module Contents :rtype: BatchPredictionVersion - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -475,7 +119,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: describe() Describe the batch prediction. @@ -487,7 +130,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: list_versions(limit = 100, start_after_version = None) Retrieves a list of versions of a given batch prediction @@ -501,7 +143,6 @@ Module Contents :rtype: list[BatchPredictionVersion] - .. py:method:: update(deployment_id = None, global_prediction_args = None, batch_prediction_args = None, explanations = None, output_format = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, name = None) Update a batch prediction job description. @@ -529,7 +170,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_file_connector_output(output_format = None, output_location = None) Updates the file connector output configuration of the batch prediction @@ -543,7 +183,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_database_connector_output(database_connector_id = None, database_output_config = None) Updates the database connector output configuration of the batch prediction @@ -557,7 +196,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_feature_group_output(table_name) Creates a feature group and sets it as the batch prediction output. @@ -569,7 +207,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_output_to_console() Sets the batch prediction output to the console, clearing both the file connector and database connector configurations. @@ -581,7 +218,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_feature_group(feature_group_type, feature_group_id = None) Sets the batch prediction input feature group. @@ -595,7 +231,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_dataset_remap(dataset_id_remap) For the purpose of this batch prediction, will swap out datasets in the training feature groups @@ -607,7 +242,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: delete() Deletes a batch prediction and associated data, such as associated monitors. @@ -616,7 +250,6 @@ Module Contents :type batch_prediction_id: str - .. py:method:: wait_for_predictions(timeout=86400) A waiting call until batch predictions are ready. @@ -625,7 +258,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_drift_monitor(timeout=86400) A waiting call until batch prediction drift monitor calculations are ready. @@ -634,7 +266,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the latest batch prediction version. @@ -643,7 +274,6 @@ Module Contents :rtype: str - .. py:method:: create_refresh_policy(cron) To create a refresh policy for a batch prediction. @@ -655,7 +285,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: list_refresh_policies() Gets the refresh policies in a list. @@ -664,7 +293,6 @@ Module Contents :rtype: List[RefreshPolicy] - .. py:method:: describe_output_feature_group() Gets the results feature group for this batch prediction @@ -673,7 +301,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: load_results_as_pandas() Loads the output feature groups into a python pandas dataframe. diff --git a/docs/_sources/autoapi/abacusai/batch_prediction_version/index.rst.txt b/docs/_sources/autoapi/abacusai/batch_prediction_version/index.rst.txt index ed7a83cea..db4b1ddb1 100644 --- a/docs/_sources/autoapi/abacusai/batch_prediction_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/batch_prediction_version/index.rst.txt @@ -1,260 +1,26 @@ -abacusai.batch_prediction_version -================================= +:py:mod:`abacusai.batch_prediction_version` +=========================================== .. py:module:: abacusai.batch_prediction_version -Classes -------- - -.. autoapisummary:: - - abacusai.batch_prediction_version.BatchPredictionArgs - abacusai.batch_prediction_version.FileFormat - abacusai.batch_prediction_version.PredictionFeatureGroup - abacusai.batch_prediction_version.PredictionInput - abacusai.batch_prediction_version.AbstractApiClass - abacusai.batch_prediction_version.BatchPredictionVersion - - Module Contents --------------- -.. py:class:: BatchPredictionArgs - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for Batch Prediction args specific to problem type. - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: FileFormat - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: AVRO - :value: 'AVRO' - - - - .. py:attribute:: PARQUET - :value: 'PARQUET' - - - - .. py:attribute:: TFRECORD - :value: 'TFRECORD' - - - - .. py:attribute:: TSV - :value: 'TSV' - - - - .. py:attribute:: CSV - :value: 'CSV' - - - - .. py:attribute:: ORC - :value: 'ORC' - - - - .. py:attribute:: JSON - :value: 'JSON' - - - - .. py:attribute:: ODS - :value: 'ODS' - - - - .. py:attribute:: XLS - :value: 'XLS' - - - - .. py:attribute:: GZ - :value: 'GZ' - - - - .. py:attribute:: ZIP - :value: 'ZIP' - - - - .. py:attribute:: TAR - :value: 'TAR' - - - - .. py:attribute:: DOCX - :value: 'DOCX' - - - - .. py:attribute:: PDF - :value: 'PDF' - - - - .. py:attribute:: RAR - :value: 'RAR' - - - - .. py:attribute:: JPEG - :value: 'JPG' - - - - .. py:attribute:: PNG - :value: 'PNG' - - - - .. py:attribute:: TIF - :value: 'TIFF' - - - - .. py:attribute:: NUMBERS - :value: 'NUMBERS' - - - - .. py:attribute:: PPTX - :value: 'PPTX' - - - - .. py:attribute:: PPT - :value: 'PPT' - - - - .. py:attribute:: HTML - :value: 'HTML' - - - - .. py:attribute:: TXT - :value: 'txt' - - - -.. py:class:: PredictionFeatureGroup(client, featureGroupId=None, featureGroupVersion=None, datasetType=None, default=None, required=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch Input Feature Group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The unique identifier of the feature group - :type featureGroupId: str - :param featureGroupVersion: The unique identifier of the feature group version used for predictions - :type featureGroupVersion: str - :param datasetType: dataset type - :type datasetType: str - :param default: If true, this feature group is the default feature group in the model - :type default: bool - :param required: If true, this feature group is required for the batch prediction - :type required: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PredictionInput(client, featureGroupDatasetIds=None, datasetIdRemap=None, featureGroups={}, datasets={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch inputs - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupDatasetIds: The list of dataset IDs to use as input - :type featureGroupDatasetIds: list - :param datasetIdRemap: Replacement datasets to swap as prediction input - :type datasetIdRemap: dict - :param featureGroups: List of prediction feature groups - :type featureGroups: PredictionFeatureGroup - :param datasets: List of prediction datasets - :type datasets: PredictionDataset - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.batch_prediction_version.BatchPredictionVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: BatchPredictionVersion(client, batchPredictionVersion=None, batchPredictionId=None, status=None, driftMonitorStatus=None, deploymentId=None, modelId=None, modelVersion=None, predictionsStartedAt=None, predictionsCompletedAt=None, databaseOutputError=None, totalPredictions=None, failedPredictions=None, databaseConnectorId=None, databaseOutputConfiguration=None, fileConnectorOutputLocation=None, fileOutputFormat=None, connectorType=None, legacyInputLocation=None, error=None, driftMonitorError=None, monitorWarnings=None, csvInputPrefix=None, csvPredictionPrefix=None, csvExplanationsPrefix=None, databaseOutputTotalWrites=None, databaseOutputFailedWrites=None, outputIncludesMetadata=None, resultInputColumns=None, modelMonitorVersion=None, algoName=None, algorithm=None, outputFeatureGroupId=None, outputFeatureGroupVersion=None, outputFeatureGroupTableName=None, batchPredictionWarnings=None, bpAcrossVersionsMonitorVersion=None, batchPredictionArgsType=None, batchInputs={}, inputFeatureGroups={}, globalPredictionArgs={}, batchPredictionArgs={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Batch Prediction Version @@ -343,13 +109,11 @@ Module Contents :param batchPredictionArgs: Argument(s) passed to every prediction call :type batchPredictionArgs: BatchPredictionArgs - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -358,7 +122,6 @@ Module Contents :rtype: dict - .. py:method:: download_batch_prediction_result_chunk(offset = 0, chunk_size = 10485760) Returns a stream containing the batch prediction results. @@ -369,7 +132,6 @@ Module Contents :type chunk_size: int - .. py:method:: get_batch_prediction_connector_errors() Returns a stream containing the batch prediction database connection write errors, if any writes failed for the specified batch prediction job. @@ -378,7 +140,6 @@ Module Contents :type batch_prediction_version: str - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -387,7 +148,6 @@ Module Contents :rtype: BatchPredictionVersion - .. py:method:: describe() Describes a Batch Prediction Version. @@ -399,7 +159,6 @@ Module Contents :rtype: BatchPredictionVersion - .. py:method:: get_logs() Retrieves the batch prediction logs. @@ -411,7 +170,6 @@ Module Contents :rtype: BatchPredictionVersionLogs - .. py:method:: download_result_to_file(file) Downloads the batch prediction version in a local file. @@ -420,7 +178,6 @@ Module Contents :type file: file object - .. py:method:: wait_for_predictions(timeout=86400) A waiting call until batch prediction version is ready. @@ -429,7 +186,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_drift_monitor(timeout=86400) A waiting call until batch prediction drift monitor calculations are ready. @@ -438,7 +194,6 @@ Module Contents :type timeout: int - .. py:method:: get_status(drift_monitor_status = False) Gets the status of the batch prediction version. @@ -447,7 +202,6 @@ Module Contents :rtype: str - .. py:method:: load_results_as_pandas() Loads the output feature groups into a python pandas dataframe. diff --git a/docs/_sources/autoapi/abacusai/batch_prediction_version_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/batch_prediction_version_logs/index.rst.txt index 8f49cd540..17977ffc6 100644 --- a/docs/_sources/autoapi/abacusai/batch_prediction_version_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/batch_prediction_version_logs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.batch_prediction_version_logs -====================================== +:py:mod:`abacusai.batch_prediction_version_logs` +================================================ .. py:module:: abacusai.batch_prediction_version_logs -Classes -------- - -.. autoapisummary:: - - abacusai.batch_prediction_version_logs.AbstractApiClass - abacusai.batch_prediction_version_logs.BatchPredictionVersionLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.batch_prediction_version_logs.BatchPredictionVersionLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: BatchPredictionVersionLogs(client, logs=None, warnings=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs from batch prediction version. @@ -41,13 +31,11 @@ Module Contents :param warnings: List of warnings from batch prediction version. :type warnings: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/categorical_range_violation/index.rst.txt b/docs/_sources/autoapi/abacusai/categorical_range_violation/index.rst.txt index eedcadbfa..74edabce3 100644 --- a/docs/_sources/autoapi/abacusai/categorical_range_violation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/categorical_range_violation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.categorical_range_violation -==================================== +:py:mod:`abacusai.categorical_range_violation` +============================================== .. py:module:: abacusai.categorical_range_violation -Classes -------- - -.. autoapisummary:: - - abacusai.categorical_range_violation.AbstractApiClass - abacusai.categorical_range_violation.CategoricalRangeViolation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.categorical_range_violation.CategoricalRangeViolation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CategoricalRangeViolation(client, name=None, mostCommonValues=None, freqOutsideTrainingRange=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Summary of important range mismatches for a numerical feature discovered by a model monitoring instance @@ -43,13 +33,11 @@ Module Contents :param freqOutsideTrainingRange: Frequency of prediction rows outside training distribution for the specified feature. :type freqOutsideTrainingRange: float - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/chat_message/index.rst.txt b/docs/_sources/autoapi/abacusai/chat_message/index.rst.txt index bf5a53c8f..ca1e26bfd 100644 --- a/docs/_sources/autoapi/abacusai/chat_message/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/chat_message/index.rst.txt @@ -1,37 +1,27 @@ -abacusai.chat_message -===================== +:py:mod:`abacusai.chat_message` +=============================== .. py:module:: abacusai.chat_message -Classes -------- - -.. autoapisummary:: - - abacusai.chat_message.AbstractApiClass - abacusai.chat_message.ChatMessage - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) +Classes +~~~~~~~ - .. py:method:: __eq__(other) +.. autoapisummary:: - Return self==value. + abacusai.chat_message.ChatMessage - .. py:method:: _get_attribute_as_dict(attribute) +.. py:class:: ChatMessage(client, role=None, text=None, timestamp=None, isUseful=None, feedback=None, docIds=None, hotkeyTitle=None, tasks=None, keywordArguments=None) -.. py:class:: ChatMessage(client, role=None, text=None, timestamp=None, isUseful=None, feedback=None, docIds=None, hotkeyTitle=None, tasks=None) Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - A single chat message with Abacus Chat. :param client: An authenticated API Client instance @@ -52,14 +42,14 @@ Module Contents :type hotkeyTitle: str :param tasks: The list of spawned tasks, if the message was broken down into smaller sub-tasks. :type tasks: list[str] - + :param keywordArguments: A dict of kwargs used to generate the response. + :type keywordArguments: dict .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/chat_session/index.rst.txt b/docs/_sources/autoapi/abacusai/chat_session/index.rst.txt index a823a3273..d2e4c38ad 100644 --- a/docs/_sources/autoapi/abacusai/chat_session/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/chat_session/index.rst.txt @@ -1,110 +1,26 @@ -abacusai.chat_session -===================== +:py:mod:`abacusai.chat_session` +=============================== .. py:module:: abacusai.chat_session -Classes -------- - -.. autoapisummary:: - - abacusai.chat_session.AiBuildingTask - abacusai.chat_session.ChatMessage - abacusai.chat_session.AbstractApiClass - abacusai.chat_session.ChatSession - - Module Contents --------------- -.. py:class:: AiBuildingTask(client, task=None, taskType=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A task for Data Science Co-pilot to help build AI. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param task: The task to be performed - :type task: str - :param taskType: The type of task - :type taskType: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ChatMessage(client, role=None, text=None, timestamp=None, isUseful=None, feedback=None, docIds=None, hotkeyTitle=None, tasks=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A single chat message with Abacus Chat. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param role: The role of the message sender - :type role: str - :param text: A list of text segments for the message - :type text: list[dict] - :param timestamp: The timestamp at which the message was sent - :type timestamp: str - :param isUseful: Whether this message was marked as useful or not - :type isUseful: bool - :param feedback: The feedback provided for the message - :type feedback: str - :param docIds: A list of IDs of the uploaded document if the message has - :type docIds: list[str] - :param hotkeyTitle: The title of the hotkey prompt if the message has one - :type hotkeyTitle: str - :param tasks: The list of spawned tasks, if the message was broken down into smaller sub-tasks. - :type tasks: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.chat_session.ChatSession - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ChatSession(client, answer=None, chatSessionId=None, projectId=None, name=None, createdAt=None, status=None, aiBuildingInProgress=None, notification=None, whiteboard=None, chatHistory={}, nextAiBuildingTask={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A chat session with Abacus Data Science Co-pilot. @@ -133,13 +49,11 @@ Module Contents :param nextAiBuildingTask: The next AI building task for the chat session :type nextAiBuildingTask: AiBuildingTask - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -148,7 +62,6 @@ Module Contents :rtype: dict - .. py:method:: get() Gets a chat session from Data Science Co-pilot. @@ -160,7 +73,6 @@ Module Contents :rtype: ChatSession - .. py:method:: delete_chat_message(message_index) Deletes a message in a chat session and its associated response. @@ -169,7 +81,6 @@ Module Contents :type message_index: int - .. py:method:: export() Exports a chat session to an HTML file @@ -178,7 +89,6 @@ Module Contents :type chat_session_id: str - .. py:method:: rename(name) Renames a chat session with Data Science Co-pilot. diff --git a/docs/_sources/autoapi/abacusai/client/index.rst.txt b/docs/_sources/autoapi/abacusai/client/index.rst.txt index a4b570cb0..47b71305d 100644 --- a/docs/_sources/autoapi/abacusai/client/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/client/index.rst.txt @@ -1,13079 +1,60 @@ -abacusai.client -=============== +:py:mod:`abacusai.client` +========================= .. py:module:: abacusai.client -Attributes ----------- - -.. autoapisummary:: - - abacusai.client.INVALID_PANDAS_COLUMN_NAME_CHARACTERS - abacusai.client.DEFAULT_SERVER - abacusai.client._request_context - abacusai.client._cached_endpoints - - -Exceptions ----------- - -.. autoapisummary:: - - abacusai.client.ApiException - abacusai.client.MissingParameterError - abacusai.client.InvalidParameterError - abacusai.client.InvalidEnumParameterError - abacusai.client.PaymentMethodRequired - abacusai.client.InvalidRequest - abacusai.client.GenericPermissionDeniedError - abacusai.client.PermissionDeniedError - abacusai.client.PaidPlanRequired - abacusai.client.Generic404Error - abacusai.client.DataNotFoundError - abacusai.client.MethodNotAllowed - abacusai.client.RequestTimeoutError - abacusai.client.ConflictError - abacusai.client.AlreadyExistsError - abacusai.client.NotReadyError - abacusai.client.FailedDependencyError - abacusai.client.TooManyRequestsError - abacusai.client.InstanceNotModifiedError - abacusai.client.GatewayTimeoutError - abacusai.client.InternalServerError - - -Classes -------- - -.. autoapisummary:: - - abacusai.client.AbacusApi - abacusai.client.Agent - abacusai.client.AgentDataExecutionResult - abacusai.client.AgentVersion - abacusai.client.Algorithm - abacusai.client.AnnotationConfig - abacusai.client.AnnotationDocument - abacusai.client.AnnotationEntry - abacusai.client.AnnotationsStatus - abacusai.client.AgentInterface - abacusai.client.AlertActionConfig - abacusai.client.AlertConditionConfig - abacusai.client.ApiClass - abacusai.client.ApiEnum - abacusai.client.ApplicationConnectorDatasetConfig - abacusai.client.BatchPredictionArgs - abacusai.client.BlobInput - abacusai.client.DatasetDocumentProcessingConfig - abacusai.client.DataType - abacusai.client.DocumentProcessingConfig - abacusai.client.EvalArtifactType - abacusai.client.ForecastingMonitorConfig - abacusai.client.IncrementalDatabaseConnectorConfig - abacusai.client.LLMName - abacusai.client.MergeConfig - abacusai.client.ParsingConfig - abacusai.client.PredictionArguments - abacusai.client.ProjectFeatureGroupConfig - abacusai.client.PythonFunctionType - abacusai.client.SamplingConfig - abacusai.client.TrainingConfig - abacusai.client.VectorStoreConfig - abacusai.client.WorkflowGraph - abacusai.client.StreamingHandler - abacusai.client.StreamType - abacusai.client.ApiEndpoint - abacusai.client.ApiKey - abacusai.client.AppUserGroup - abacusai.client.ApplicationConnector - abacusai.client.BatchPrediction - abacusai.client.BatchPredictionVersion - abacusai.client.BatchPredictionVersionLogs - abacusai.client.ChatMessage - abacusai.client.ChatSession - abacusai.client.CustomLossFunction - abacusai.client.CustomMetric - abacusai.client.CustomMetricVersion - abacusai.client.CustomTrainFunctionInfo - abacusai.client.DataMetrics - abacusai.client.DataPrepLogs - abacusai.client.DatabaseConnector - abacusai.client.DatabaseConnectorSchema - abacusai.client.Dataset - abacusai.client.DatasetColumn - abacusai.client.DatasetVersion - abacusai.client.DatasetVersionLogs - abacusai.client.Deployment - abacusai.client.DeploymentAuthToken - abacusai.client.DeploymentConversation - abacusai.client.DeploymentConversationExport - abacusai.client.DocumentData - abacusai.client.DocumentRetriever - abacusai.client.DocumentRetrieverLookupResult - abacusai.client.DocumentRetrieverVersion - abacusai.client.DriftDistributions - abacusai.client.Eda - abacusai.client.EdaCollinearity - abacusai.client.EdaDataConsistency - abacusai.client.EdaFeatureAssociation - abacusai.client.EdaFeatureCollinearity - abacusai.client.EdaForecastingAnalysis - abacusai.client.EdaVersion - abacusai.client.ExecuteFeatureGroupOperation - abacusai.client.ExternalApplication - abacusai.client.ExternalInvite - abacusai.client.ExtractedFields - abacusai.client.Feature - abacusai.client.FeatureDistribution - abacusai.client.FeatureGroup - abacusai.client.FeatureGroupExport - abacusai.client.FeatureGroupExportConfig - abacusai.client.FeatureGroupExportDownloadUrl - abacusai.client.FeatureGroupRow - abacusai.client.FeatureGroupRowProcess - abacusai.client.FeatureGroupRowProcessLogs - abacusai.client.FeatureGroupRowProcessSummary - abacusai.client.FeatureGroupTemplate - abacusai.client.FeatureGroupVersion - abacusai.client.FeatureGroupVersionLogs - abacusai.client.FeatureImportance - abacusai.client.FileConnector - abacusai.client.FileConnectorInstructions - abacusai.client.FileConnectorVerification - abacusai.client.FunctionLogs - abacusai.client.GeneratedPitFeatureConfigOption - abacusai.client.GraphDashboard - abacusai.client.HoldoutAnalysis - abacusai.client.HoldoutAnalysisVersion - abacusai.client.InferredFeatureMappings - abacusai.client.LlmApp - abacusai.client.LlmExecutionResult - abacusai.client.LlmGeneratedCode - abacusai.client.LlmInput - abacusai.client.LlmResponse - abacusai.client.Model - abacusai.client.ModelArtifactsExport - abacusai.client.ModelMetrics - abacusai.client.ModelMonitor - abacusai.client.ModelMonitorOrgSummary - abacusai.client.ModelMonitorSummary - abacusai.client.ModelMonitorSummaryFromOrg - abacusai.client.ModelMonitorVersion - abacusai.client.ModelMonitorVersionMetricData - abacusai.client.ModelTrainingTypeForDeployment - abacusai.client.ModelUpload - abacusai.client.ModelVersion - abacusai.client.ModelVersionFeatureGroupSchema - abacusai.client.ModificationLockInfo - abacusai.client.Module - abacusai.client.MonitorAlert - abacusai.client.MonitorAlertVersion - abacusai.client.NaturalLanguageExplanation - abacusai.client.OrganizationGroup - abacusai.client.OrganizationSearchResult - abacusai.client.OrganizationSecret - abacusai.client.PageData - abacusai.client.Pipeline - abacusai.client.PipelineStep - abacusai.client.PipelineStepVersion - abacusai.client.PipelineStepVersionLogs - abacusai.client.PipelineVersion - abacusai.client.PipelineVersionLogs - abacusai.client.PredictionOperator - abacusai.client.PredictionOperatorVersion - abacusai.client.ProblemType - abacusai.client.Project - abacusai.client.ProjectConfig - abacusai.client.ProjectFeatureGroup - abacusai.client.ProjectValidation - abacusai.client.PythonFunction - abacusai.client.PythonPlotFunction - abacusai.client.RealtimeMonitor - abacusai.client.RefreshPipelineRun - abacusai.client.RefreshPolicy - abacusai.client.ResolvedFeatureGroupTemplate - abacusai.client.AbstractApiClass - abacusai.client.Schema - abacusai.client.StreamingAuthToken - abacusai.client.StreamingConnector - abacusai.client.TrainingConfigOptions - abacusai.client.Upload - abacusai.client.UploadPart - abacusai.client.UseCase - abacusai.client.UseCaseRequirements - abacusai.client.User - abacusai.client.WebSearchResponse - abacusai.client.Webhook - abacusai.client.Blob - abacusai.client.AgentResponse - abacusai.client.ClientOptions - abacusai.client._ApiExceptionFactory - abacusai.client.BaseApiClient - abacusai.client.ReadOnlyClient - abacusai.client.ApiClient - - -Functions ---------- - -.. autoapisummary:: - - abacusai.client.get_clean_function_source_code - abacusai.client.snake_case - abacusai.client.clean_column_name - abacusai.client.get_object_from_context - abacusai.client._is_json_serializable - abacusai.client.sse_asynchronous_generator - abacusai.client._requests_retry_session - abacusai.client._discover_service_url - abacusai.client.get_source_code_info - abacusai.client.get_module_code_from_notebook - abacusai.client.include_modules - - -Module Contents ---------------- - -.. py:class:: AbacusApi(client, method=None, docstring=None, score=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Abacus API. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param method: The name of of the API method. - :type method: str - :param docstring: The docstring of the API method. - :type docstring: str - :param score: The relevance score of the API method. - :type score: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Agent(client, name=None, agentId=None, createdAt=None, projectId=None, notebookId=None, predictFunctionName=None, sourceCode=None, agentConfig=None, memory=None, trainingRequired=None, agentExecutionConfig=None, codeSource={}, latestAgentVersion={}, workflowGraph={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An AI agent. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The user-friendly name for the agent. - :type name: str - :param agentId: The unique identifier of the agent. - :type agentId: str - :param createdAt: Date and time at which the agent was created. - :type createdAt: str - :param projectId: The project this agent belongs to. - :type projectId: str - :param notebookId: The notebook associated with the agent. - :type notebookId: str - :param predictFunctionName: Name of the function found in the source code that will be executed run predictions through agent. It is not executed when this function is run. - :type predictFunctionName: str - :param sourceCode: Python code used to make the agent. - :type sourceCode: str - :param agentConfig: The config options used to create this agent. - :type agentConfig: dict - :param memory: Memory in GB specified for the deployment resources for the agent. - :type memory: int - :param trainingRequired: Whether training is required to deploy the latest agent code. - :type trainingRequired: bool - :param agentExecutionConfig: The config for arguments used to execute the agent. - :type agentExecutionConfig: dict - :param latestAgentVersion: The latest agent version. - :type latestAgentVersion: AgentVersion - :param codeSource: If a python model, information on the source code - :type codeSource: CodeSource - :param workflowGraph: The workflow graph for the agent. - :type workflowGraph: WorkflowGraph - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Agent - - - - .. py:method:: describe() - - Retrieves a full description of the specified model. - - :param agent_id: Unique string identifier associated with the model. - :type agent_id: str - - :returns: Description of the agent. - :rtype: Agent - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - List all versions of an agent. - - :param limit: If provided, limits the number of agent versions returned. - :type limit: int - :param start_after_version: Unique string identifier of the version after which the list starts. - :type start_after_version: str - - :returns: An array of Agent versions. - :rtype: list[AgentVersion] - - - - .. py:method:: wait_for_publish(timeout=None) - - A waiting call until agent is published. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the agent publishing. - - :returns: A string describing the status of a agent publishing (pending, complete, etc.). - :rtype: str - - - -.. py:class:: AgentDataExecutionResult(client, response=None, deploymentConversationId=None, docInfos={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Results of agent execution with uploaded data. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param response: The result of agent conversation execution. - :type response: str - :param deploymentConversationId: The unique identifier of the deployment conversation. - :type deploymentConversationId: id - :param docInfos: A list of dict containing information on documents uploaded to agent. - :type docInfos: AgentDataDocumentInfo - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AgentVersion(client, agentVersion=None, status=None, agentId=None, agentConfig=None, publishingStartedAt=None, publishingCompletedAt=None, pendingDeploymentIds=None, failedDeploymentIds=None, error=None, agentExecutionConfig=None, codeSource={}, workflowGraph={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of an AI agent. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param agentVersion: The unique identifier of an agent version. - :type agentVersion: str - :param status: The current status of the model. - :type status: str - :param agentId: A reference to the agent this version belongs to. - :type agentId: str - :param agentConfig: The config options used to create this agent. - :type agentConfig: dict - :param publishingStartedAt: The start time and date of the training process in ISO-8601 format. - :type publishingStartedAt: str - :param publishingCompletedAt: The end time and date of the training process in ISO-8601 format. - :type publishingCompletedAt: str - :param pendingDeploymentIds: List of deployment IDs where deployment is pending. - :type pendingDeploymentIds: list - :param failedDeploymentIds: List of failed deployment IDs. - :type failedDeploymentIds: list - :param error: Relevant error if the status is FAILED. - :type error: str - :param agentExecutionConfig: The config for arguments used to execute the agent. - :type agentExecutionConfig: dict - :param codeSource: If a python model, information on where the source code is located. - :type codeSource: CodeSource - :param workflowGraph: The workflow graph for the agent. - :type workflowGraph: WorkflowGraph - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: AgentVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified agent version. - - :param agent_version: Unique string identifier of the agent version. - :type agent_version: str - - :returns: A agent version. - :rtype: AgentVersion - - - - .. py:method:: wait_for_publish(timeout=None) - - A waiting call until agent gets published. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model version under training. - - :returns: A string describing the status of a model training (pending, complete, etc.). - :rtype: str - - - -.. py:class:: Algorithm(client, name=None, problemType=None, createdAt=None, updatedAt=None, isDefaultEnabled=None, trainingInputMappings=None, trainFunctionName=None, predictFunctionName=None, predictManyFunctionName=None, initializeFunctionName=None, configOptions=None, algorithmId=None, useGpu=None, algorithmTrainingConfig=None, onlyOfflineDeployable=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Customer created algorithm - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the algorithm - :type name: str - :param problemType: The type of the problem this algorithm will work on - :type problemType: str - :param createdAt: When the algorithm was created - :type createdAt: str - :param updatedAt: When the algorithm was last updated - :type updatedAt: str - :param isDefaultEnabled: Whether train with the algorithm by default - :type isDefaultEnabled: bool - :param trainingInputMappings: The mappings for train function parameters' names, e.g. names for training data, name for training config - :type trainingInputMappings: dict - :param trainFunctionName: Name of the function found in the source code that will be executed to train the model. It is not executed when this function is run. - :type trainFunctionName: str - :param predictFunctionName: Name of the function found in the source code that will be executed run predictions through model. It is not executed when this function is run. - :type predictFunctionName: str - :param predictManyFunctionName: Name of the function found in the source code that will be executed for batch prediction of the model. It is not executed when this function is run. - :type predictManyFunctionName: str - :param initializeFunctionName: Name of the function found in the source code to initialize the trained model before using it to make predictions using the model - :type initializeFunctionName: str - :param configOptions: Map dataset types and configs to train function parameter names - :type configOptions: dict - :param algorithmId: The unique identifier of the algorithm - :type algorithmId: str - :param useGpu: Whether to use gpu for model training - :type useGpu: bool - :param algorithmTrainingConfig: The algorithm specific training config - :type algorithmTrainingConfig: dict - :param onlyOfflineDeployable: Whether or not the algorithm is only allowed to be deployed offline - :type onlyOfflineDeployable: bool - :param codeSource: Info about the source code of the algorithm - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Annotation config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureAnnotationConfigs: List of feature annotation configs - :type featureAnnotationConfigs: list - :param labels: List of labels - :type labels: list - :param statusFeature: Name of the feature that contains the status of the annotation (Optional) - :type statusFeature: str - :param commentsFeatures: Features that contain comments for the annotation (Optional) - :type commentsFeatures: list - :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional) - :type metadataFeature: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AnnotationDocument(client, docId=None, featureGroupRowIdentifier=None, featureGroupRowIndex=None, totalRows=None, isAnnotationPresent=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Document to be annotated. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param docId: The docstore Document ID of the document. - :type docId: str - :param featureGroupRowIdentifier: The key value of the feature group row the annotation is on. Usually the primary key value. - :type featureGroupRowIdentifier: str - :param featureGroupRowIndex: The index of the document row in the feature group. - :type featureGroupRowIndex: int - :param totalRows: The total number of rows in the feature group. - :type totalRows: int - :param isAnnotationPresent: Whether the document already has an annotation. Returns None if feature group is not under annotations review mode. - :type isAnnotationPresent: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AnnotationEntry(client, featureGroupId=None, featureName=None, docId=None, featureGroupRowIdentifier=None, updatedAt=None, annotationEntryMarker=None, status=None, lockedUntil=None, verificationInfo=None, annotation={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Annotation Store entry for an Annotation - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The ID of the feature group this annotation belongs to. - :type featureGroupId: str - :param featureName: name of the feature this annotation is on. - :type featureName: str - :param docId: The ID of the primary document the annotation is on. - :type docId: str - :param featureGroupRowIdentifier: The key value of the feature group row the annotation is on (cast to string). Usually the primary key value. - :type featureGroupRowIdentifier: str - :param updatedAt: Most recent time the annotation entry was modified, e.g. creation or update time. - :type updatedAt: str - :param annotationEntryMarker: The entry marker for the annotation. - :type annotationEntryMarker: str - :param status: The status of labeling the document. - :type status: str - :param lockedUntil: The time until which the document is locked for editing, in ISO-8601 format. - :type lockedUntil: str - :param verificationInfo: The verification info for the annotation. - :type verificationInfo: dict - :param annotation: json-compatible structure holding the type and value of the annotation. - :type annotation: Annotation - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AnnotationsStatus(client, total=None, done=None, inProgress=None, todo=None, latestUpdatedAt=None, isMaterializationNeeded=None, latestMaterializedAnnotationConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The status of annotations for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param total: The total number of documents annotated - :type total: int - :param done: The number of documents annotated - :type done: int - :param inProgress: The number of documents currently being annotated - :type inProgress: int - :param todo: The number of documents that need to be annotated - :type todo: int - :param latestUpdatedAt: The latest time an annotation was updated (ISO-8601 format) - :type latestUpdatedAt: str - :param isMaterializationNeeded: Whether feature group needs to be materialized before using for annotations - :type isMaterializationNeeded: bool - :param latestMaterializedAnnotationConfig: The annotation config corresponding to the latest materialized feature group - :type latestMaterializedAnnotationConfig: AnnotationConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AgentInterface - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: DEFAULT - :value: 'DEFAULT' - - - - .. py:attribute:: CHAT - :value: 'CHAT' - - - -.. py:class:: AlertActionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert action configs - - - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: AlertConditionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert condition configs - - - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: ApiClass - - Bases: :py:obj:`abc.ABC` - - - Helper class that provides a standard way to create an ABC using - inheritance. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:method:: __post_init__() - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __str__() - - Return str(self). - - - - .. py:method:: _repr_html_() - - - .. py:method:: __getitem__(item) - - - .. py:method:: __setitem__(item, value) - - - .. py:method:: _unset_item(item) - - - .. py:method:: get(item, default = None) - - - .. py:method:: pop(item, default = NotImplemented) - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(input_dict) - :classmethod: - - - -.. py:class:: ApiEnum - - Bases: :py:obj:`enum.Enum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: __hash__() - - Return hash(self). - - - -.. py:class:: ApplicationConnectorDatasetConfig - - Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` - - - An abstract class for dataset configs specific to application connectors. - - :param application_connector_type: The type of application connector - :type application_connector_type: enums.ApplicationConnectorType - - - .. py:attribute:: application_connector_type - :type: abacusai.api_class.enums.ApplicationConnectorType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: BatchPredictionArgs - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for Batch Prediction args specific to problem type. - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: BlobInput - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Binary large object input data. - - :param filename: The original filename of the blob. - :type filename: str - :param contents: The binary contents of the blob. - :type contents: bytes - :param mime_type: The mime type of the blob. - :type mime_type: str - :param size: The size of the blob in bytes. - :type size: int - - - .. py:attribute:: filename - :type: str - - - .. py:attribute:: contents - :type: bytes - - - .. py:attribute:: mime_type - :type: str - - - .. py:attribute:: size - :type: int - - - .. py:method:: from_local_file(file_path) - :classmethod: - - - - .. py:method:: from_contents(contents, filename = None, mime_type = None) - :classmethod: - - - -.. py:class:: DatasetDocumentProcessingConfig - - Bases: :py:obj:`DocumentProcessingConfig` - - - Document processing configuration for dataset imports. - - :param extract_bounding_boxes: Whether to perform OCR and extract bounding boxes. If False, no OCR will be done but only the embedded text from digital documents will be extracted. Defaults to False. - :type extract_bounding_boxes: bool - :param ocr_mode: OCR mode. There are different OCR modes available for different kinds of documents and use cases. This option only takes effect when extract_bounding_boxes is True. - :type ocr_mode: OcrMode - :param use_full_ocr: Whether to perform full OCR. If True, OCR will be performed on the full page. If False, OCR will be performed on the non-text regions only. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type use_full_ocr: bool - :param remove_header_footer: Whether to remove headers and footers. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type remove_header_footer: bool - :param remove_watermarks: Whether to remove watermarks. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type remove_watermarks: bool - :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type convert_to_markdown: bool - :param page_text_column: Name of the output column which contains the extracted text for each page. If not provided, no column will be created. - :type page_text_column: str - - - .. py:attribute:: page_text_column - :type: str - :value: None - - - -.. py:class:: DataType - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: INTEGER - :value: 'integer' - - - - .. py:attribute:: FLOAT - :value: 'float' - - - - .. py:attribute:: STRING - :value: 'string' - - - - .. py:attribute:: DATE - :value: 'date' - - - - .. py:attribute:: DATETIME - :value: 'datetime' - - - - .. py:attribute:: BOOLEAN - :value: 'boolean' - - - - .. py:attribute:: LIST - :value: 'list' - - - - .. py:attribute:: STRUCT - :value: 'struct' - - - - .. py:attribute:: NULL - :value: 'null' - - - -.. py:class:: DocumentProcessingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Document processing configuration. - - :param extract_bounding_boxes: Whether to perform OCR and extract bounding boxes. If False, no OCR will be done but only the embedded text from digital documents will be extracted. Defaults to False. - :type extract_bounding_boxes: bool - :param ocr_mode: OCR mode. There are different OCR modes available for different kinds of documents and use cases. This option only takes effect when extract_bounding_boxes is True. - :type ocr_mode: OcrMode - :param use_full_ocr: Whether to perform full OCR. If True, OCR will be performed on the full page. If False, OCR will be performed on the non-text regions only. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type use_full_ocr: bool - :param remove_header_footer: Whether to remove headers and footers. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type remove_header_footer: bool - :param remove_watermarks: Whether to remove watermarks. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type remove_watermarks: bool - :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type convert_to_markdown: bool - - - .. py:attribute:: extract_bounding_boxes - :type: bool - :value: False - - - - .. py:attribute:: ocr_mode - :type: abacusai.api_class.enums.OcrMode - - - .. py:attribute:: use_full_ocr - :type: bool - :value: None - - - - .. py:attribute:: remove_header_footer - :type: bool - :value: False - - - - .. py:attribute:: remove_watermarks - :type: bool - :value: True - - - - .. py:attribute:: convert_to_markdown - :type: bool - :value: False - - - -.. py:class:: EvalArtifactType - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: FORECASTING_ACCURACY - :value: 'bar_chart' - - - - .. py:attribute:: FORECASTING_VOLUME - :value: 'bar_chart_volume' - - - - .. py:attribute:: FORECASTING_HISTORY_LENGTH_ACCURACY - :value: 'bar_chart_accuracy_by_history' - - - -.. py:class:: ForecastingMonitorConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Forecasting Monitor Configuration - - :param id_column: The name of the column that contains the unique identifier for the time series. - :type id_column: str - :param timestamp_column: The name of the column that contains the timestamp for the time series. - :type timestamp_column: str - :param target_column: The name of the column that contains the target value for the time series. - :type target_column: str - :param start_time: The start time of the time series data. - :type start_time: str - :param end_time: The end time of the time series data. - :type end_time: str - :param window_config: The windowing configuration for the time series data. - :type window_config: TimeWindowConfig - - - .. py:attribute:: id_column - :type: str - - - .. py:attribute:: timestamp_column - :type: str - - - .. py:attribute:: target_column - :type: str - - - .. py:attribute:: start_time - :type: str - - - .. py:attribute:: end_time - :type: str - - - .. py:attribute:: window_config - :type: TimeWindowConfig - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - -.. py:class:: IncrementalDatabaseConnectorConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Config information for incremental datasets from database connectors - - :param timestamp_column: If dataset is incremental, this is the column name of the required column in the dataset. This column must contain timestamps in descending order which are used to determine the increments of the incremental dataset. - :type timestamp_column: str - - - .. py:attribute:: timestamp_column - :type: str - - -.. py:class:: LLMName - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: OPENAI_GPT4 - :value: 'OPENAI_GPT4' - - - - .. py:attribute:: OPENAI_GPT4_32K - :value: 'OPENAI_GPT4_32K' - - - - .. py:attribute:: OPENAI_GPT4_128K - :value: 'OPENAI_GPT4_128K' - - - - .. py:attribute:: OPENAI_GPT4_128K_LATEST - :value: 'OPENAI_GPT4_128K_LATEST' - - - - .. py:attribute:: OPENAI_GPT4_VISION - :value: 'OPENAI_GPT4_VISION' - - - - .. py:attribute:: OPENAI_GPT4O - :value: 'OPENAI_GPT4O' - - - - .. py:attribute:: OPENAI_GPT3_5 - :value: 'OPENAI_GPT3_5' - - - - .. py:attribute:: OPENAI_GPT3_5_TEXT - :value: 'OPENAI_GPT3_5_TEXT' - - - - .. py:attribute:: LLAMA3_LARGE_CHAT - :value: 'LLAMA3_LARGE_CHAT' - - - - .. py:attribute:: GROQ_LLAMA3_LARGE_CHAT - :value: 'GROQ_LLAMA3_LARGE_CHAT' - - - - .. py:attribute:: CLAUDE_V2_1 - :value: 'CLAUDE_V2_1' - - - - .. py:attribute:: CLAUDE_V3_OPUS - :value: 'CLAUDE_V3_OPUS' - - - - .. py:attribute:: CLAUDE_V3_SONNET - :value: 'CLAUDE_V3_SONNET' - - - - .. py:attribute:: CLAUDE_V3_HAIKU - :value: 'CLAUDE_V3_HAIKU' - - - - .. py:attribute:: ABACUS_GIRAFFE - :value: 'ABACUS_GIRAFFE' - - - - .. py:attribute:: ABACUS_GIRAFFE_LARGE - :value: 'ABACUS_GIRAFFE_LARGE' - - - - .. py:attribute:: LLAMA2_CHAT - :value: 'LLAMA2_CHAT' - - - - .. py:attribute:: PALM - :value: 'PALM' - - - - .. py:attribute:: PALM_TEXT - :value: 'PALM_TEXT' - - - - .. py:attribute:: GEMINI_PRO - :value: 'GEMINI_PRO' - - - - .. py:attribute:: GEMINI_1_5_PRO - :value: 'GEMINI_1_5_PRO' - - - - .. py:attribute:: MIXTRAL_CHAT - :value: 'MIXTRAL_CHAT' - - - - .. py:attribute:: MISTRAL_MEDIUM - :value: 'MISTRAL_MEDIUM' - - - - .. py:attribute:: ABACUS_SMAUG3 - :value: 'ABACUS_SMAUG3' - - - -.. py:class:: MergeConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the merge config of a feature group - - - .. py:attribute:: merge_mode - :type: abacusai.api_class.enums.MergeMode - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __post_init__() - - -.. py:class:: ParsingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Custom config for dataset parsing. - - :param escape: Escape character for CSV files. Defaults to '"'. - :type escape: str - :param csv_delimiter: Delimiter for CSV files. Defaults to None. - :type csv_delimiter: str - :param file_path_with_schema: Path to the file with schema. Defaults to None. - :type file_path_with_schema: str - - - .. py:attribute:: escape - :type: str - - - .. py:attribute:: csv_delimiter - :type: str - - - .. py:attribute:: file_path_with_schema - :type: str - - -.. py:class:: PredictionArguments - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for prediction arguments specific to problem type. - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: ProjectFeatureGroupConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for project feature group configuration. - - - .. py:attribute:: type - :type: abacusai.api_class.enums.ProjectConfigType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: PythonFunctionType - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: FEATURE_GROUP - :value: 'FEATURE_GROUP' - - - - .. py:attribute:: PLOTLY_FIG - :value: 'PLOTLY_FIG' - - - - .. py:attribute:: STEP_FUNCTION - :value: 'STEP_FUNCTION' - - - -.. py:class:: SamplingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the sampling config of a feature group - - - .. py:attribute:: sampling_method - :type: abacusai.api_class.enums.SamplingMethodType - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __post_init__() - - -.. py:class:: TrainingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the training config options used to train the model. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:attribute:: algorithm - :type: str - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: VectorStoreConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Config for indexing options of a document retriever. Default values of optional arguments are heuristically selected by the Abacus.AI platform based on the underlying data. - - :param chunk_size: The size of text chunks in the vector store. - :type chunk_size: int - :param chunk_overlap_fraction: The fraction of overlap between chunks. - :type chunk_overlap_fraction: float - :param text_encoder: Encoder used to index texts from the documents. - :type text_encoder: VectorStoreTextEncoder - :param chunk_size_factors: Chunking data with multiple sizes. The specified list of factors are used to calculate more sizes, in addition to `chunk_size`. - :type chunk_size_factors: list - :param score_multiplier_column: If provided, will use the values in this metadata column to modify the relevance score of returned chunks for all queries. - :type score_multiplier_column: str - :param prune_vectors: Transform vectors using SVD so that the average component of vectors in the corpus are removed. - :type prune_vectors: bool - - - .. py:attribute:: chunk_size - :type: int - - - .. py:attribute:: chunk_overlap_fraction - :type: float - - - .. py:attribute:: text_encoder - :type: abacusai.api_class.enums.VectorStoreTextEncoder - - - .. py:attribute:: chunk_size_factors - :type: list - - - .. py:attribute:: score_multiplier_column - :type: str - - - .. py:attribute:: prune_vectors - :type: bool - - -.. py:function:: get_clean_function_source_code(func) - -.. py:function:: snake_case(value) - -.. py:class:: WorkflowGraph - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. - - :param nodes: A list of nodes in the workflow graph. - :type nodes: List[WorkflowGraphNode] - :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. - :type edges: List[WorkflowGraphEdge] - - - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] - - - .. py:attribute:: edges - :type: List[WorkflowGraphEdge] - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(graph) - :classmethod: - - - -.. py:data:: INVALID_PANDAS_COLUMN_NAME_CHARACTERS - :value: '[^A-Za-z0-9_]' - - -.. py:class:: StreamingHandler - - Bases: :py:obj:`str` - - - str(object='') -> str - str(bytes_or_buffer[, encoding[, errors]]) -> str - - Create a new string object from the given object. If encoding or - errors is specified, then the object must expose a data buffer - that will be decoded using the given encoding and error handler. - Otherwise, returns the result of object.__str__() (if defined) - or repr(object). - encoding defaults to sys.getdefaultencoding(). - errors defaults to 'strict'. - - - .. py:method:: process_streaming_data(value, context, section_key, data_type) - :classmethod: - - - -.. py:class:: StreamType - - Bases: :py:obj:`enum.Enum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: MESSAGE - :value: 'message' - - - - .. py:attribute:: SECTION_OUTPUT - :value: 'section_output' - - - -.. py:function:: clean_column_name(column) - -.. py:function:: get_object_from_context(client, context, variable_name, return_type) - -.. py:class:: ApiEndpoint(client, apiEndpoint=None, predictEndpoint=None, proxyEndpoint=None, llmEndpoint=None, externalChatEndpoint=None, dashboardEndpoint=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An collection of endpoints which can be used to make requests to, such as api calls or predict calls - - :param client: An authenticated API Client instance - :type client: ApiClient - :param apiEndpoint: The URI that can be used to make API calls - :type apiEndpoint: str - :param predictEndpoint: The URI that can be used to make predict calls against Deployments - :type predictEndpoint: str - :param proxyEndpoint: The URI that can be used to make proxy server calls - :type proxyEndpoint: str - :param llmEndpoint: The URI that can be used to make llm api calls - :type llmEndpoint: str - :param externalChatEndpoint: The URI that can be used to access the external chat - :type externalChatEndpoint: str - :param dashboardEndpoint: The URI that the external chat will use to go back to the dashboard - :type dashboardEndpoint: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ApiKey(client, apiKeyId=None, apiKey=None, tag=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An API Key to authenticate requests to the Abacus.AI API - - :param client: An authenticated API Client instance - :type client: ApiClient - :param apiKeyId: The unique ID for the API key - :type apiKeyId: str - :param apiKey: The unique API key scoped to a specific organization. Value will be partially obscured. - :type apiKey: str - :param tag: A user-friendly tag for the API key. - :type tag: str - :param createdAt: The timestamp when the API key was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete a specified API key. - - :param api_key_id: The ID of the API key to delete. - :type api_key_id: str - - - -.. py:class:: AppUserGroup(client, name=None, userGroupId=None, externalApplicationIds=None, invitedUserEmails=None, publicUserGroup=None, hasExternalApplicationReporting=None, isExternalServiceGroup=None, externalServiceGroupId=None, users={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An app user group. This is used to determine which users have permissions for external chatbots. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the user group. - :type name: str - :param userGroupId: The unique identifier of the user group. - :type userGroupId: str - :param externalApplicationIds: The ids of the external applications the group has access to. - :type externalApplicationIds: list[str] - :param invitedUserEmails: The emails of the users invited to the user group who have not yet accepted the invite. - :type invitedUserEmails: list[str] - :param publicUserGroup: Boolean flag whether the app user group is the public user group of the org or not. - :type publicUserGroup: bool - :param hasExternalApplicationReporting: Whether users in the App User Group have permission to view all reports in their organization. - :type hasExternalApplicationReporting: bool - :param isExternalServiceGroup: Whether the App User Group corresponds to a user group that's defined in an external service (i.e Microsft Active Directory or Okta) or not - :type isExternalServiceGroup: bool - :param externalServiceGroupId: The identifier that corresponds to the app user group's external service group representation - :type externalServiceGroupId: str - :param users: The users in the user group. - :type users: User - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ApplicationConnector(client, applicationConnectorId=None, service=None, name=None, createdAt=None, status=None, auth=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A connector to an external service - - :param client: An authenticated API Client instance - :type client: ApiClient - :param applicationConnectorId: The unique ID for the connection. - :type applicationConnectorId: str - :param service: The service this connection connects to - :type service: str - :param name: A user-friendly name for the service - :type name: str - :param createdAt: When the API key was created - :type createdAt: str - :param status: The status of the Application Connector - :type status: str - :param auth: Non-secret connection information for this connector - :type auth: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: rename(name) - - Renames a Application Connector - - :param name: A new name for the application connector. - :type name: str - - - - .. py:method:: delete() - - Delete an application connector. - - :param application_connector_id: The unique identifier for the application connector. - :type application_connector_id: str - - - - .. py:method:: list_objects() - - Lists querable objects in the application connector. - - :param application_connector_id: Unique string identifier for the application connector. - :type application_connector_id: str - - - - .. py:method:: verify() - - Checks if Abacus.AI can access the application using the provided application connector ID. - - :param application_connector_id: Unique string identifier for the application connector. - :type application_connector_id: str - - - -.. py:class:: BatchPrediction(client, batchPredictionId=None, createdAt=None, name=None, deploymentId=None, fileConnectorOutputLocation=None, databaseConnectorId=None, databaseOutputConfiguration=None, fileOutputFormat=None, connectorType=None, legacyInputLocation=None, outputFeatureGroupId=None, featureGroupTableName=None, outputFeatureGroupTableName=None, summaryFeatureGroupTableName=None, csvInputPrefix=None, csvPredictionPrefix=None, csvExplanationsPrefix=None, outputIncludesMetadata=None, resultInputColumns=None, modelMonitorId=None, modelVersion=None, bpAcrossVersionsMonitorId=None, algorithm=None, batchPredictionArgsType=None, batchInputs={}, latestBatchPredictionVersion={}, refreshSchedules={}, inputFeatureGroups={}, globalPredictionArgs={}, batchPredictionArgs={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Make batch predictions. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param batchPredictionId: The unique identifier of the batch prediction request. - :type batchPredictionId: str - :param createdAt: When the batch prediction was created, in ISO-8601 format. - :type createdAt: str - :param name: Name given to the batch prediction object. - :type name: str - :param deploymentId: The deployment used to make the predictions. - :type deploymentId: str - :param fileConnectorOutputLocation: Contains information about where the batch predictions are written to. - :type fileConnectorOutputLocation: str - :param databaseConnectorId: The database connector to write the results to. - :type databaseConnectorId: str - :param databaseOutputConfiguration: Contains information about where the batch predictions are written to. - :type databaseOutputConfiguration: dict - :param fileOutputFormat: The format of the batch prediction output (CSV or JSON). - :type fileOutputFormat: str - :param connectorType: Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR. - :type connectorType: str - :param legacyInputLocation: The location of the input data. - :type legacyInputLocation: str - :param outputFeatureGroupId: The Batch Prediction output feature group ID if applicable - :type outputFeatureGroupId: str - :param featureGroupTableName: The table name of the Batch Prediction output feature group. - :type featureGroupTableName: str - :param outputFeatureGroupTableName: The table name of the Batch Prediction output feature group. - :type outputFeatureGroupTableName: str - :param summaryFeatureGroupTableName: The table name of the metrics summary feature group output by Batch Prediction. - :type summaryFeatureGroupTableName: str - :param csvInputPrefix: A prefix to prepend to the input columns, only applies when output format is CSV. - :type csvInputPrefix: str - :param csvPredictionPrefix: A prefix to prepend to the prediction columns, only applies when output format is CSV. - :type csvPredictionPrefix: str - :param csvExplanationsPrefix: A prefix to prepend to the explanation columns, only applies when output format is CSV. - :type csvExplanationsPrefix: str - :param outputIncludesMetadata: If true, output will contain columns including prediction start time, batch prediction version, and model version. - :type outputIncludesMetadata: bool - :param resultInputColumns: If present, will limit result files or feature groups to only include columns present in this list. - :type resultInputColumns: list - :param modelMonitorId: The model monitor for this batch prediction. - :type modelMonitorId: str - :param modelVersion: The model instance used in the deployment for the batch prediction. - :type modelVersion: str - :param bpAcrossVersionsMonitorId: The model monitor for this batch prediction across versions. - :type bpAcrossVersionsMonitorId: str - :param algorithm: The algorithm that is currently deployed. - :type algorithm: str - :param batchPredictionArgsType: The type of batch prediction arguments used for this batch prediction. - :type batchPredictionArgsType: str - :param batchInputs: Inputs to the batch prediction. - :type batchInputs: PredictionInput - :param latestBatchPredictionVersion: The latest batch prediction version. - :type latestBatchPredictionVersion: BatchPredictionVersion - :param refreshSchedules: List of refresh schedules that dictate the next time the batch prediction will be run. - :type refreshSchedules: RefreshSchedule - :param inputFeatureGroups: List of prediction feature groups. - :type inputFeatureGroups: PredictionFeatureGroup - :param globalPredictionArgs: - :type globalPredictionArgs: BatchPredictionArgs - :param batchPredictionArgs: Argument(s) passed to every prediction call. - :type batchPredictionArgs: BatchPredictionArgs - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: start() - - Creates a new batch prediction version job for a given batch prediction job description. - - :param batch_prediction_id: The unique identifier of the batch prediction to create a new version of. - :type batch_prediction_id: str - - :returns: The batch prediction version started by this method call. - :rtype: BatchPredictionVersion - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: BatchPrediction - - - - .. py:method:: describe() - - Describe the batch prediction. - - :param batch_prediction_id: The unique identifier associated with the batch prediction. - :type batch_prediction_id: str - - :returns: The batch prediction description. - :rtype: BatchPrediction - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of versions of a given batch prediction - - :param limit: Number of versions to list. - :type limit: int - :param start_after_version: Version to start after. - :type start_after_version: str - - :returns: List of batch prediction versions. - :rtype: list[BatchPredictionVersion] - - - - .. py:method:: update(deployment_id = None, global_prediction_args = None, batch_prediction_args = None, explanations = None, output_format = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, name = None) - - Update a batch prediction job description. - - :param deployment_id: Unique identifier of the deployment. - :type deployment_id: str - :param batch_prediction_args: Batch Prediction args specific to problem type. - :type batch_prediction_args: BatchPredictionArgs - :param output_format: If specified, sets the format of the batch prediction output (CSV or JSON). - :type output_format: str - :param csv_input_prefix: Prefix to prepend to the input columns, only applies when output format is CSV. - :type csv_input_prefix: str - :param csv_prediction_prefix: Prefix to prepend to the prediction columns, only applies when output format is CSV. - :type csv_prediction_prefix: str - :param csv_explanations_prefix: Prefix to prepend to the explanation columns, only applies when output format is CSV. - :type csv_explanations_prefix: str - :param output_includes_metadata: If True, output will contain columns including prediction start time, batch prediction version, and model version. - :type output_includes_metadata: bool - :param result_input_columns: If present, will limit result files or feature groups to only include columns present in this list. - :type result_input_columns: list - :param name: If present, will rename the batch prediction. - :type name: str - - :returns: The batch prediction. - :rtype: BatchPrediction - - - - .. py:method:: set_file_connector_output(output_format = None, output_location = None) - - Updates the file connector output configuration of the batch prediction - - :param output_format: The format of the batch prediction output (CSV or JSON). If not specified, the default format will be used. - :type output_format: str - :param output_location: The location to write the prediction results. If not specified, results will be stored in Abacus.AI. - :type output_location: str - - :returns: The batch prediction description. - :rtype: BatchPrediction - - - - .. py:method:: set_database_connector_output(database_connector_id = None, database_output_config = None) - - Updates the database connector output configuration of the batch prediction - - :param database_connector_id: Unique string identifier of an Database Connection to write predictions to. - :type database_connector_id: str - :param database_output_config: Key-value pair of columns/values to write to the database connector. - :type database_output_config: dict - - :returns: Description of the batch prediction. - :rtype: BatchPrediction - - - - .. py:method:: set_feature_group_output(table_name) - - Creates a feature group and sets it as the batch prediction output. - - :param table_name: Name of the feature group table to create. - :type table_name: str - - :returns: Batch prediction after the output has been applied. - :rtype: BatchPrediction - - - - .. py:method:: set_output_to_console() - - Sets the batch prediction output to the console, clearing both the file connector and database connector configurations. - - :param batch_prediction_id: The unique identifier of the batch prediction. - :type batch_prediction_id: str - - :returns: The batch prediction description. - :rtype: BatchPrediction - - - - .. py:method:: set_feature_group(feature_group_type, feature_group_id = None) - - Sets the batch prediction input feature group. - - :param feature_group_type: Enum string representing the feature group type to set. The type is based on the use case under which the feature group is being created (e.g. Catalog Attributes for personalized recommendation use case). - :type feature_group_type: str - :param feature_group_id: Unique identifier of the feature group to set as input to the batch prediction. - :type feature_group_id: str - - :returns: Description of the batch prediction. - :rtype: BatchPrediction - - - - .. py:method:: set_dataset_remap(dataset_id_remap) - - For the purpose of this batch prediction, will swap out datasets in the training feature groups - - :param dataset_id_remap: Key/value pairs of dataset ids to be replaced during the batch prediction. - :type dataset_id_remap: dict - - :returns: Batch prediction object. - :rtype: BatchPrediction - - - - .. py:method:: delete() - - Deletes a batch prediction and associated data, such as associated monitors. - - :param batch_prediction_id: Unique string identifier of the batch prediction. - :type batch_prediction_id: str - - - - .. py:method:: wait_for_predictions(timeout=86400) - - A waiting call until batch predictions are ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_drift_monitor(timeout=86400) - - A waiting call until batch prediction drift monitor calculations are ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the latest batch prediction version. - - :returns: A string describing the status of the latest batch prediction version e.g., pending, complete, etc. - :rtype: str - - - - .. py:method:: create_refresh_policy(cron) - - To create a refresh policy for a batch prediction. - - :param cron: A cron style string to set the refresh time. - :type cron: str - - :returns: The refresh policy object. - :rtype: RefreshPolicy - - - - .. py:method:: list_refresh_policies() - - Gets the refresh policies in a list. - - :returns: A list of refresh policy objects. - :rtype: List[RefreshPolicy] - - - - .. py:method:: describe_output_feature_group() - - Gets the results feature group for this batch prediction - - :returns: A feature group object. - :rtype: FeatureGroup - - - - .. py:method:: load_results_as_pandas() - - Loads the output feature groups into a python pandas dataframe. - - :returns: A pandas dataframe with annotations and text_snippet columns. - :rtype: DataFrame - - - -.. py:class:: BatchPredictionVersion(client, batchPredictionVersion=None, batchPredictionId=None, status=None, driftMonitorStatus=None, deploymentId=None, modelId=None, modelVersion=None, predictionsStartedAt=None, predictionsCompletedAt=None, databaseOutputError=None, totalPredictions=None, failedPredictions=None, databaseConnectorId=None, databaseOutputConfiguration=None, fileConnectorOutputLocation=None, fileOutputFormat=None, connectorType=None, legacyInputLocation=None, error=None, driftMonitorError=None, monitorWarnings=None, csvInputPrefix=None, csvPredictionPrefix=None, csvExplanationsPrefix=None, databaseOutputTotalWrites=None, databaseOutputFailedWrites=None, outputIncludesMetadata=None, resultInputColumns=None, modelMonitorVersion=None, algoName=None, algorithm=None, outputFeatureGroupId=None, outputFeatureGroupVersion=None, outputFeatureGroupTableName=None, batchPredictionWarnings=None, bpAcrossVersionsMonitorVersion=None, batchPredictionArgsType=None, batchInputs={}, inputFeatureGroups={}, globalPredictionArgs={}, batchPredictionArgs={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch Prediction Version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param batchPredictionVersion: The unique identifier of the batch prediction version - :type batchPredictionVersion: str - :param batchPredictionId: The unique identifier of the batch prediction - :type batchPredictionId: str - :param status: The current status of the batch prediction - :type status: str - :param driftMonitorStatus: The status of the drift monitor for this batch prediction version - :type driftMonitorStatus: str - :param deploymentId: The deployment used to make the predictions - :type deploymentId: str - :param modelId: The model used to make the predictions - :type modelId: str - :param modelVersion: The model version used to make the predictions - :type modelVersion: str - :param predictionsStartedAt: Predictions start date and time - :type predictionsStartedAt: str - :param predictionsCompletedAt: Predictions completion date and time - :type predictionsCompletedAt: str - :param databaseOutputError: If true, there were errors reported by the database connector while writing - :type databaseOutputError: bool - :param totalPredictions: Number of predictions performed in this batch prediction job - :type totalPredictions: int - :param failedPredictions: Number of predictions that failed - :type failedPredictions: int - :param databaseConnectorId: The database connector to write the results to - :type databaseConnectorId: str - :param databaseOutputConfiguration: Contains information about where the batch predictions are written to - :type databaseOutputConfiguration: dict - :param fileConnectorOutputLocation: Contains information about where the batch predictions are written to - :type fileConnectorOutputLocation: str - :param fileOutputFormat: The format of the batch prediction output (CSV or JSON) - :type fileOutputFormat: str - :param connectorType: Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR - :type connectorType: str - :param legacyInputLocation: The location of the input data - :type legacyInputLocation: str - :param error: Relevant error if the status is FAILED - :type error: str - :param driftMonitorError: Error message for the drift monitor of this batch predcition - :type driftMonitorError: str - :param monitorWarnings: Relevant warning if there are issues found in drift or data integrity - :type monitorWarnings: str - :param csvInputPrefix: A prefix to prepend to the input columns, only applies when output format is CSV - :type csvInputPrefix: str - :param csvPredictionPrefix: A prefix to prepend to the prediction columns, only applies when output format is CSV - :type csvPredictionPrefix: str - :param csvExplanationsPrefix: A prefix to prepend to the explanation columns, only applies when output format is CSV - :type csvExplanationsPrefix: str - :param databaseOutputTotalWrites: The total number of rows attempted to write (may be less than total_predictions if write mode is UPSERT and multiple rows share the same ID) - :type databaseOutputTotalWrites: int - :param databaseOutputFailedWrites: The number of failed writes to the Database Connector - :type databaseOutputFailedWrites: int - :param outputIncludesMetadata: If true, output will contain columns including prediction start time, batch prediction version, and model version - :type outputIncludesMetadata: bool - :param resultInputColumns: If present, will limit result files or feature groups to only include columns present in this list - :type resultInputColumns: list[str] - :param modelMonitorVersion: The version of the model monitor - :type modelMonitorVersion: str - :param algoName: The name of the algorithm used to train the model - :type algoName: str - :param algorithm: The algorithm that is currently deployed. - :type algorithm: str - :param outputFeatureGroupId: The Batch Prediction output feature group ID if applicable - :type outputFeatureGroupId: str - :param outputFeatureGroupVersion: The Batch Prediction output feature group version if applicable - :type outputFeatureGroupVersion: str - :param outputFeatureGroupTableName: The Batch Prediction output feature group name if applicable - :type outputFeatureGroupTableName: str - :param batchPredictionWarnings: Relevant warnings if any issues are found - :type batchPredictionWarnings: str - :param bpAcrossVersionsMonitorVersion: The version of the batch prediction across versions monitor - :type bpAcrossVersionsMonitorVersion: str - :param batchPredictionArgsType: The type of the batch prediction args - :type batchPredictionArgsType: str - :param batchInputs: Inputs to the batch prediction - :type batchInputs: PredictionInput - :param inputFeatureGroups: List of prediction feature groups - :type inputFeatureGroups: PredictionFeatureGroup - :param globalPredictionArgs: - :type globalPredictionArgs: BatchPredictionArgs - :param batchPredictionArgs: Argument(s) passed to every prediction call - :type batchPredictionArgs: BatchPredictionArgs - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: download_batch_prediction_result_chunk(offset = 0, chunk_size = 10485760) - - Returns a stream containing the batch prediction results. - - :param offset: The offset to read from. - :type offset: int - :param chunk_size: The maximum amount of data to read. - :type chunk_size: int - - - - .. py:method:: get_batch_prediction_connector_errors() - - Returns a stream containing the batch prediction database connection write errors, if any writes failed for the specified batch prediction job. - - :param batch_prediction_version: Unique string identifier of the batch prediction job to get the errors for. - :type batch_prediction_version: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: BatchPredictionVersion - - - - .. py:method:: describe() - - Describes a Batch Prediction Version. - - :param batch_prediction_version: Unique string identifier of the Batch Prediction Version. - :type batch_prediction_version: str - - :returns: The Batch Prediction Version. - :rtype: BatchPredictionVersion - - - - .. py:method:: get_logs() - - Retrieves the batch prediction logs. - - :param batch_prediction_version: The unique version ID of the batch prediction version. - :type batch_prediction_version: str - - :returns: The logs for the specified batch prediction version. - :rtype: BatchPredictionVersionLogs - - - - .. py:method:: download_result_to_file(file) - - Downloads the batch prediction version in a local file. - - :param file: A file object opened in a binary mode e.g., file=open('/tmp/output', 'wb'). - :type file: file object - - - - .. py:method:: wait_for_predictions(timeout=86400) - - A waiting call until batch prediction version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_drift_monitor(timeout=86400) - - A waiting call until batch prediction drift monitor calculations are ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status(drift_monitor_status = False) - - Gets the status of the batch prediction version. - - :returns: A string describing the status of the batch prediction version, for e.g., pending, complete, etc. - :rtype: str - - - - .. py:method:: load_results_as_pandas() - - Loads the output feature groups into a python pandas dataframe. - - :returns: A pandas dataframe with annotations and text_snippet columns. - :rtype: DataFrame - - - -.. py:class:: BatchPredictionVersionLogs(client, logs=None, warnings=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs from batch prediction version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param logs: List of logs from batch prediction version. - :type logs: list[str] - :param warnings: List of warnings from batch prediction version. - :type warnings: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ChatMessage(client, role=None, text=None, timestamp=None, isUseful=None, feedback=None, docIds=None, hotkeyTitle=None, tasks=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A single chat message with Abacus Chat. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param role: The role of the message sender - :type role: str - :param text: A list of text segments for the message - :type text: list[dict] - :param timestamp: The timestamp at which the message was sent - :type timestamp: str - :param isUseful: Whether this message was marked as useful or not - :type isUseful: bool - :param feedback: The feedback provided for the message - :type feedback: str - :param docIds: A list of IDs of the uploaded document if the message has - :type docIds: list[str] - :param hotkeyTitle: The title of the hotkey prompt if the message has one - :type hotkeyTitle: str - :param tasks: The list of spawned tasks, if the message was broken down into smaller sub-tasks. - :type tasks: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ChatSession(client, answer=None, chatSessionId=None, projectId=None, name=None, createdAt=None, status=None, aiBuildingInProgress=None, notification=None, whiteboard=None, chatHistory={}, nextAiBuildingTask={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A chat session with Abacus Data Science Co-pilot. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param answer: The response from the chatbot - :type answer: str - :param chatSessionId: The chat session id - :type chatSessionId: str - :param projectId: The project id associated with the chat session - :type projectId: str - :param name: The name of the chat session - :type name: str - :param createdAt: The timestamp at which the chat session was created - :type createdAt: str - :param status: The status of the chat sessions - :type status: str - :param aiBuildingInProgress: Whether the AI building is in progress or not - :type aiBuildingInProgress: bool - :param notification: A warn/info message about the chat session. For example, a suggestion to create a new session if the current one is too old - :type notification: str - :param whiteboard: A set of whiteboard notes associated with the chat session - :type whiteboard: str - :param chatHistory: The chat history for the conversation - :type chatHistory: ChatMessage - :param nextAiBuildingTask: The next AI building task for the chat session - :type nextAiBuildingTask: AiBuildingTask - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get() - - Gets a chat session from Data Science Co-pilot. - - :param chat_session_id: Unique ID of the chat session. - :type chat_session_id: str - - :returns: The chat session with Data Science Co-pilot - :rtype: ChatSession - - - - .. py:method:: delete_chat_message(message_index) - - Deletes a message in a chat session and its associated response. - - :param message_index: The index of the chat message within the UI. - :type message_index: int - - - - .. py:method:: export() - - Exports a chat session to an HTML file - - :param chat_session_id: Unique ID of the chat session. - :type chat_session_id: str - - - - .. py:method:: rename(name) - - Renames a chat session with Data Science Co-pilot. - - :param name: The new name of the chat session. - :type name: str - - - -.. py:class:: CustomLossFunction(client, notebookId=None, name=None, createdAt=None, lossFunctionName=None, lossFunctionType=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Custom Loss Function - - :param client: An authenticated API Client instance - :type client: ApiClient - :param notebookId: The unique identifier of the notebook used to create/edit the loss function. - :type notebookId: str - :param name: Name assigned to the custom loss function. - :type name: str - :param createdAt: When the loss function was created. - :type createdAt: str - :param lossFunctionName: The name of the function defined in the source code. - :type lossFunctionName: str - :param lossFunctionType: The category of problems that this loss would be applicable to, e.g. regression, multi-label classification, etc. - :type lossFunctionType: str - :param codeSource: Information about the source code of the loss function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: CustomMetric(client, customMetricId=None, name=None, createdAt=None, problemType=None, notebookId=None, latestCustomMetricVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Custom metric. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param customMetricId: Unique string identifier of the custom metric. - :type customMetricId: str - :param name: Name assigned to the custom metric. - :type name: str - :param createdAt: Date and time when the custom metric was created (ISO 8601 format). - :type createdAt: str - :param problemType: Problem type that this custom metric is applicable to (e.g. regression). - :type problemType: str - :param notebookId: Unique string identifier of the notebook used to create/edit the custom metric. - :type notebookId: str - :param latestCustomMetricVersion: Latest version of the custom metric. - :type latestCustomMetricVersion: CustomMetricVersion - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: CustomMetricVersion(client, customMetricVersion=None, name=None, createdAt=None, customMetricFunctionName=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Custom metric version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param customMetricVersion: Unique string identifier for the custom metric version. - :type customMetricVersion: str - :param name: Name assigned to the custom metric. - :type name: str - :param createdAt: ISO-8601 string indicating when the custom metric was created. - :type createdAt: str - :param customMetricFunctionName: The name of the function defined in the source code. - :type customMetricFunctionName: str - :param codeSource: Information about the source code of the custom metric. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: CustomMetricVersion - - - - .. py:method:: describe() - - Describes a given custom metric version - - :param custom_metric_version: A unique string identifier for the custom metric version. - :type custom_metric_version: str - - :returns: An object describing the custom metric version. - :rtype: CustomMetricVersion - - - -.. py:class:: CustomTrainFunctionInfo(client, trainingDataParameterNameMapping=None, schemaMappings=None, trainDataParameterToFeatureGroupIds=None, trainingConfig=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Information about how to call the customer provided train function. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param trainingDataParameterNameMapping: The mapping from feature group type to the dataframe parameter name - :type trainingDataParameterNameMapping: dict - :param schemaMappings: The feature type to feature name mapping for each dataframe - :type schemaMappings: dict - :param trainDataParameterToFeatureGroupIds: The mapping from the dataframe parameter name to the feature group id backing the data - :type trainDataParameterToFeatureGroupIds: dict - :param trainingConfig: The configs for training - :type trainingConfig: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DataMetrics(client, metrics=None, schema=None, numRows=None, numCols=None, numDuplicateRows=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Processed Metrics and Schema for a dataset version or feature group version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param metrics: A list of dicts with metrics for each columns - :type metrics: list[dict] - :param schema: A list of dicts with the schema for each metric - :type schema: list[dict] - :param numRows: The number of rows - :type numRows: int - :param numCols: The number of columns - :type numCols: int - :param numDuplicateRows: The number of duplicate rows - :type numDuplicateRows: int - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DataPrepLogs(client, logs=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs from data preparation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param logs: List of logs from data preparation during model training. - :type logs: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DatabaseConnector(client, databaseConnectorId=None, service=None, name=None, status=None, auth=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A connector to an external service - - :param client: An authenticated API Client instance - :type client: ApiClient - :param databaseConnectorId: A unique string identifier for the connection. - :type databaseConnectorId: str - :param service: An enum string indicating the service this connection connects to. - :type service: str - :param name: A user-friendly name for the service. - :type name: str - :param status: The status of the database connector. - :type status: str - :param auth: Non-secret connection information for this connector. - :type auth: dict - :param createdAt: The ISO-8601 string indicating when the API key was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: list_objects(fetch_raw_data = False) - - Lists querable objects in the database connector. - - :param fetch_raw_data: If true, return unfiltered objects. - :type fetch_raw_data: bool - - - - .. py:method:: get_object_schema(object_name = None, fetch_raw_data = False) - - Get the schema of an object in an database connector. - - :param object_name: Unique identifier for the object in the external system. - :type object_name: str - :param fetch_raw_data: If true, return unfiltered list of columns. - :type fetch_raw_data: bool - - :returns: The schema of the object. - :rtype: DatabaseConnectorSchema - - - - .. py:method:: rename(name) - - Renames a Database Connector - - :param name: The new name for the Database Connector. - :type name: str - - - - .. py:method:: verify() - - Checks if Abacus.AI can access the specified database. - - :param database_connector_id: Unique string identifier for the database connector. - :type database_connector_id: str - - - - .. py:method:: delete() - - Delete a database connector. - - :param database_connector_id: The unique identifier for the database connector. - :type database_connector_id: str - - - - .. py:method:: query(query) - - Runs a query in the specified database connector. - - :param query: The query to be run in the database connector. - :type query: str - - - -.. py:class:: DatabaseConnectorSchema(client, tableName=None, columns={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a table from a database connector - - :param client: An authenticated API Client instance - :type client: ApiClient - :param tableName: The unique name of the table. - :type tableName: str - :param columns: List of columns in the table. - :type columns: DatabaseConnectorColumn - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Dataset(client, datasetId=None, sourceType=None, dataSource=None, createdAt=None, ignoreBefore=None, ephemeral=None, lookbackDays=None, databaseConnectorId=None, databaseConnectorConfig=None, connectorType=None, featureGroupTableName=None, applicationConnectorId=None, applicationConnectorConfig=None, incremental=None, isDocumentset=None, extractBoundingBoxes=None, mergeFileSchemas=None, referenceOnlyDocumentset=None, schema={}, refreshSchedules={}, latestDatasetVersion={}, parsingConfig={}, documentProcessingConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A dataset reference - - :param client: An authenticated API Client instance - :type client: ApiClient - :param datasetId: The unique identifier of the dataset. - :type datasetId: str - :param sourceType: The source of the Dataset. EXTERNAL_SERVICE, UPLOAD, or STREAMING. - :type sourceType: str - :param dataSource: Location of data. It may be a URI such as an s3 bucket or the database table. - :type dataSource: str - :param createdAt: The timestamp at which this dataset was created. - :type createdAt: str - :param ignoreBefore: The timestamp at which all previous events are ignored when training. - :type ignoreBefore: str - :param ephemeral: The dataset is ephemeral and not used for training. - :type ephemeral: bool - :param lookbackDays: Specific to streaming datasets, this specifies how many days worth of data to include when generating a snapshot. Value of 0 indicates leaves this selection to the system. - :type lookbackDays: int - :param databaseConnectorId: The Database Connector used. - :type databaseConnectorId: str - :param databaseConnectorConfig: The database connector query used to retrieve data. - :type databaseConnectorConfig: dict - :param connectorType: The type of connector used to get this dataset FILE or DATABASE. - :type connectorType: str - :param featureGroupTableName: The table name of the dataset's feature group - :type featureGroupTableName: str - :param applicationConnectorId: The Application Connector used. - :type applicationConnectorId: str - :param applicationConnectorConfig: The application connector query used to retrieve data. - :type applicationConnectorConfig: dict - :param incremental: If dataset is an incremental dataset. - :type incremental: bool - :param isDocumentset: If dataset is a documentset. - :type isDocumentset: bool - :param extractBoundingBoxes: Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True. - :type extractBoundingBoxes: bool - :param mergeFileSchemas: If the merge file schemas policy is enabled. - :type mergeFileSchemas: bool - :param referenceOnlyDocumentset: Signifies whether to save the data reference only. Only valid if is_documentset if True. - :type referenceOnlyDocumentset: bool - :param latestDatasetVersion: The latest version of this dataset. - :type latestDatasetVersion: DatasetVersion - :param schema: List of resolved columns. - :type schema: DatasetColumn - :param refreshSchedules: List of schedules that determines when the next version of the dataset will be created. - :type refreshSchedules: RefreshSchedule - :param parsingConfig: The parsing config used for dataset. - :type parsingConfig: ParsingConfig - :param documentProcessingConfig: The document processing config used for dataset (when is_documentset is True). - :type documentProcessingConfig: DocumentProcessingConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: create_version_from_file_connector(location = None, file_format = None, csv_delimiter = None, merge_file_schemas = None, parsing_config = None) - - Creates a new version of the specified dataset. - - :param location: External URI to import the dataset from. If not specified, the last location will be used. - :type location: str - :param file_format: File format to be used. If not specified, the service will try to detect the file format. - :type file_format: str - :param csv_delimiter: If the file format is CSV, use a specific CSV delimiter. - :type csv_delimiter: str - :param merge_file_schemas: Signifies if the merge file schema policy is enabled. - :type merge_file_schemas: bool - :param parsing_config: Custom config for dataset parsing. - :type parsing_config: ParsingConfig - - :returns: The new Dataset Version created. - :rtype: DatasetVersion - - - - .. py:method:: create_version_from_database_connector(object_name = None, columns = None, query_arguments = None, sql_query = None) - - Creates a new version of the specified dataset. - - :param object_name: The name/ID of the object in the service to query. If not specified, the last name will be used. - :type object_name: str - :param columns: The columns to query from the external service object. If not specified, the last columns will be used. - :type columns: str - :param query_arguments: Additional query arguments to filter the data. If not specified, the last arguments will be used. - :type query_arguments: str - :param sql_query: The full SQL query to use when fetching data. If present, this parameter will override object_name, columns, and query_arguments. - :type sql_query: str - - :returns: The new Dataset Version created. - :rtype: DatasetVersion - - - - .. py:method:: create_version_from_application_connector(dataset_config = None) - - Creates a new version of the specified dataset. - - :param dataset_config: Dataset config for the application connector. If any of the fields are not specified, the last values will be used. - :type dataset_config: ApplicationConnectorDatasetConfig - - :returns: The new Dataset Version created. - :rtype: DatasetVersion - - - - .. py:method:: create_version_from_upload(file_format = None) - - Creates a new version of the specified dataset using a local file upload. - - :param file_format: File format to be used. If not specified, the service will attempt to detect the file format. - :type file_format: str - - :returns: Token to be used when uploading file parts. - :rtype: Upload - - - - .. py:method:: create_version_from_document_reprocessing(document_processing_config = None) - - Creates a new dataset version for a source docstore dataset with the provided document processing configuration. This does not re-import the data but uses the same data which is imported in the latest dataset version and only performs document processing on it. - - :param document_processing_config: The document processing configuration to use for the new dataset version. If not specified, the document processing configuration from the source dataset will be used. - :type document_processing_config: DatasetDocumentProcessingConfig - - :returns: The new dataset version created. - :rtype: DatasetVersion - - - - .. py:method:: snapshot_streaming_data() - - Snapshots the current data in the streaming dataset. - - :param dataset_id: The unique ID associated with the dataset. - :type dataset_id: str - - :returns: The new Dataset Version created by taking a snapshot of the current data in the streaming dataset. - :rtype: DatasetVersion - - - - .. py:method:: set_column_data_type(column, data_type) - - Set a Dataset's column type. - - :param column: The name of the column. - :type column: str - :param data_type: The type of the data in the column. Note: Some ColumnMappings may restrict the options or explicitly set the DataType. - :type data_type: DataType - - :returns: The dataset and schema after the data type has been set. - :rtype: Dataset - - - - .. py:method:: set_streaming_retention_policy(retention_hours = None, retention_row_count = None, ignore_records_before_timestamp = None) - - Sets the streaming retention policy. - - :param retention_hours: Number of hours to retain streamed data in memory. - :type retention_hours: int - :param retention_row_count: Number of rows to retain streamed data in memory. - :type retention_row_count: int - :param ignore_records_before_timestamp: The Unix timestamp (in seconds) to use as a cutoff to ignore all entries sent before it - :type ignore_records_before_timestamp: int - - - - .. py:method:: get_schema() - - Retrieves the column schema of a dataset. - - :param dataset_id: Unique string identifier of the dataset schema to look up. - :type dataset_id: str - - :returns: List of column schema definitions. - :rtype: list[DatasetColumn] - - - - .. py:method:: set_database_connector_config(database_connector_id, object_name = None, columns = None, query_arguments = None, sql_query = None) - - Sets database connector config for a dataset. This method is currently only supported for streaming datasets. - - :param database_connector_id: Unique String Identifier of the Database Connector to import the dataset from. - :type database_connector_id: str - :param object_name: If applicable, the name/ID of the object in the service to query. - :type object_name: str - :param columns: The columns to query from the external service object. - :type columns: str - :param query_arguments: Additional query arguments to filter the data. - :type query_arguments: str - :param sql_query: The full SQL query to use when fetching data. If present, this parameter will override `object_name`, `columns` and `query_arguments`. - :type sql_query: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Dataset - - - - .. py:method:: describe() - - Retrieves a full description of the specified dataset, with attributes such as its ID, name, source type, etc. - - :param dataset_id: The unique ID associated with the dataset. - :type dataset_id: str - - :returns: The dataset. - :rtype: Dataset - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of all dataset versions for the specified dataset. - - :param limit: The maximum length of the list of all dataset versions. - :type limit: int - :param start_after_version: The ID of the version after which the list starts. - :type start_after_version: str - - :returns: A list of dataset versions. - :rtype: list[DatasetVersion] - - - - .. py:method:: delete() - - Deletes the specified dataset from the organization. - - :param dataset_id: Unique string identifier of the dataset to delete. - :type dataset_id: str - - - - .. py:method:: wait_for_import(timeout=900) - - A waiting call until dataset is imported. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_inspection(timeout=None) - - A waiting call until dataset is completely inspected. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the latest dataset version. - - :returns: A string describing the status of a dataset (importing, inspecting, complete, etc.). - :rtype: str - - - - .. py:method:: describe_feature_group() - - Gets the feature group attached to the dataset. - - :returns: A feature group object. - :rtype: FeatureGroup - - - - .. py:method:: create_refresh_policy(cron) - - To create a refresh policy for a dataset. - - :param cron: A cron style string to set the refresh time. - :type cron: str - - :returns: The refresh policy object. - :rtype: RefreshPolicy - - - - .. py:method:: list_refresh_policies() - - Gets the refresh policies in a list. - - :returns: A list of refresh policy objects. - :rtype: List[RefreshPolicy] - - - -.. py:class:: DatasetColumn(client, name=None, dataType=None, detectedDataType=None, featureType=None, detectedFeatureType=None, originalName=None, validDataTypes=None, timeFormat=None, timestampFrequency=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a column - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column. - :type name: str - :param dataType: The underlying data type of each column. - :type dataType: str - :param detectedDataType: The detected data type of the column. - :type detectedDataType: str - :param featureType: Feature type of the column. - :type featureType: str - :param detectedFeatureType: The detected feature type of the column. - :type detectedFeatureType: str - :param originalName: The original name of the column. - :type originalName: str - :param validDataTypes: The valid data type options for this column. - :type validDataTypes: list[str] - :param timeFormat: The detected time format of the column. - :type timeFormat: str - :param timestampFrequency: The detected frequency of the timestamps in the dataset. - :type timestampFrequency: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DatasetVersion(client, datasetVersion=None, status=None, datasetId=None, size=None, rowCount=None, fileInspectMetadata=None, createdAt=None, error=None, incrementalQueriedAt=None, uploadId=None, mergeFileSchemas=None, databaseConnectorConfig=None, applicationConnectorConfig=None, invalidRecords=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A specific version of a dataset - - :param client: An authenticated API Client instance - :type client: ApiClient - :param datasetVersion: The unique identifier of the dataset version. - :type datasetVersion: str - :param status: The current status of the dataset version - :type status: str - :param datasetId: A reference to the Dataset this dataset version belongs to. - :type datasetId: str - :param size: The size in bytes of the file. - :type size: int - :param rowCount: Number of rows in the dataset version. - :type rowCount: int - :param fileInspectMetadata: Metadata information about file's inspection. For example - the detected delimiter for CSV files. - :type fileInspectMetadata: dict - :param createdAt: The timestamp this dataset version was created. - :type createdAt: str - :param error: If status is FAILED, this field will be populated with an error. - :type error: str - :param incrementalQueriedAt: If the dataset version is from an incremental dataset, this is the last entry of timestamp column when the dataset version was created. - :type incrementalQueriedAt: str - :param uploadId: If the dataset version is being uploaded, this the reference to the Upload - :type uploadId: str - :param mergeFileSchemas: If the merge file schemas policy is enabled. - :type mergeFileSchemas: bool - :param databaseConnectorConfig: The database connector query used to retrieve data for this version. - :type databaseConnectorConfig: dict - :param applicationConnectorConfig: The application connector used to retrieve data for this version. - :type applicationConnectorConfig: dict - :param invalidRecords: Invalid records in the dataset version - :type invalidRecords: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) - - Get metrics for a specific dataset version. - - :param selected_columns: A list of columns to order first. - :type selected_columns: List - :param include_charts: A flag indicating whether charts should be included in the response. Default is false. - :type include_charts: bool - :param include_statistics: A flag indicating whether statistics should be included in the response. Default is true. - :type include_statistics: bool - - :returns: The metrics for the specified Dataset version. - :rtype: DataMetrics - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DatasetVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified dataset version, including its ID, name, source type, and other attributes. - - :param dataset_version: Unique string identifier associated with the dataset version. - :type dataset_version: str - - :returns: The dataset version. - :rtype: DatasetVersion - - - - .. py:method:: get_logs() - - Retrieves the dataset import logs. - - :param dataset_version: The unique version ID of the dataset version. - :type dataset_version: str - - :returns: The logs for the specified dataset version. - :rtype: DatasetVersionLogs - - - - .. py:method:: wait_for_import(timeout=900) - - A waiting call until dataset version is imported. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_inspection(timeout=None) - - A waiting call until dataset version is completely inspected. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the dataset version. - - :returns: A string describing the status of a dataset version (importing, inspecting, complete, etc.). - :rtype: str - - - -.. py:class:: DatasetVersionLogs(client, logs=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs from dataset version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param logs: List of logs from dataset version. - :type logs: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Deployment(client, deploymentId=None, name=None, status=None, description=None, deployedAt=None, createdAt=None, projectId=None, modelId=None, modelVersion=None, featureGroupId=None, featureGroupVersion=None, callsPerSecond=None, autoDeploy=None, skipMetricsCheck=None, algoName=None, regions=None, error=None, batchStreamingUpdates=None, algorithm=None, pendingModelVersion=None, modelDeploymentConfig=None, predictionOperatorId=None, predictionOperatorVersion=None, pendingPredictionOperatorVersion=None, onlineFeatureGroupId=None, outputOnlineFeatureGroupId=None, realtimeMonitorId=None, refreshSchedules={}, featureGroupExportConfig={}, defaultPredictionArguments={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A model deployment - - :param client: An authenticated API Client instance - :type client: ApiClient - :param deploymentId: A unique identifier for the deployment. - :type deploymentId: str - :param name: A user-friendly name for the deployment. - :type name: str - :param status: The status of the deployment. - :type status: str - :param description: A description of the deployment. - :type description: str - :param deployedAt: The date and time when the deployment became active, in ISO-8601 format. - :type deployedAt: str - :param createdAt: The date and time when the deployment was created, in ISO-8601 format. - :type createdAt: str - :param projectId: A unique identifier for the project this deployment belongs to. - :type projectId: str - :param modelId: The model that is currently deployed. - :type modelId: str - :param modelVersion: The model version ID that is currently deployed. - :type modelVersion: str - :param featureGroupId: The feature group that is currently deployed. - :type featureGroupId: str - :param featureGroupVersion: The feature group version ID that is currently deployed. - :type featureGroupVersion: str - :param callsPerSecond: The number of calls per second the deployment can handle. - :type callsPerSecond: int - :param autoDeploy: A flag marking the deployment as eligible for auto deployments whenever any model in the project finishes training. - :type autoDeploy: bool - :param skipMetricsCheck: A flag to skip metric regression with this current deployment. This field is only relevant when auto_deploy is on - :type skipMetricsCheck: bool - :param algoName: The name of the algorithm that is currently deployed. - :type algoName: str - :param regions: A list of regions that the deployment has been deployed to. - :type regions: list - :param error: The relevant error, if the status is FAILED. - :type error: str - :param batchStreamingUpdates: A flag marking the feature group deployment as having enabled a background process which caches streamed-in rows for quicker lookup. - :type batchStreamingUpdates: bool - :param algorithm: The algorithm that is currently deployed. - :type algorithm: str - :param pendingModelVersion: The model that the deployment is switching to, or being stopped. - :type pendingModelVersion: dict - :param modelDeploymentConfig: The config for which model to be deployed. - :type modelDeploymentConfig: dict - :param predictionOperatorId: The prediction operator ID that is currently deployed. - :type predictionOperatorId: str - :param predictionOperatorVersion: The prediction operator version ID that is currently deployed. - :type predictionOperatorVersion: str - :param pendingPredictionOperatorVersion: The prediction operator version ID that the deployment is switching to, or being stopped. - :type pendingPredictionOperatorVersion: str - :param onlineFeatureGroupId: The online feature group ID that the deployment is running on - :type onlineFeatureGroupId: id - :param outputOnlineFeatureGroupId: The online feature group ID that the deployment is outputting results to - :type outputOnlineFeatureGroupId: id - :param realtimeMonitorId: The realtime monitor ID of the realtime-monitor that is associated with the deployment - :type realtimeMonitorId: id - :param refreshSchedules: A list of refresh schedules that indicate when the deployment will be updated to the latest model version. - :type refreshSchedules: RefreshSchedule - :param featureGroupExportConfig: The export config (file connector or database connector information) for feature group deployment exports. - :type featureGroupExportConfig: FeatureGroupExportConfig - :param defaultPredictionArguments: The default prediction arguments for prediction APIs - :type defaultPredictionArguments: PredictionArguments - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: create_webhook(endpoint, webhook_event_type, payload_template = None) - - Create a webhook attached to a given deployment ID. - - :param endpoint: URI that the webhook will send HTTP POST requests to. - :type endpoint: str - :param webhook_event_type: One of 'DEPLOYMENT_START', 'DEPLOYMENT_SUCCESS', or 'DEPLOYMENT_FAILED'. - :type webhook_event_type: str - :param payload_template: Template for the body of the HTTP POST requests. Defaults to {}. - :type payload_template: dict - - :returns: The webhook attached to the deployment. - :rtype: Webhook - - - - .. py:method:: list_webhooks() - - List all the webhooks attached to a given deployment. - - :param deployment_id: Unique identifier of the target deployment. - :type deployment_id: str - - :returns: List of the webhooks attached to the given deployment ID. - :rtype: list[Webhook] - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Deployment - - - - .. py:method:: describe() - - Retrieves a full description of the specified deployment. - - :param deployment_id: Unique string identifier associated with the deployment. - :type deployment_id: str - - :returns: Description of the deployment. - :rtype: Deployment - - - - .. py:method:: update(description = None, auto_deploy = None, skip_metrics_check = None) - - Updates a deployment's properties. - - :param description: The new description for the deployment. - :type description: str - :param auto_deploy: Flag to enable the automatic deployment when a new Model Version finishes training. - :type auto_deploy: bool - :param skip_metrics_check: Flag to skip metric regression with this current deployment. This field is only relevant when auto_deploy is on - :type skip_metrics_check: bool - - - - .. py:method:: rename(name) - - Updates a deployment's name - - :param name: The new deployment name. - :type name: str - - - - .. py:method:: set_auto(enable = None) - - Enable or disable auto deployment for the specified deployment. - - When a model is scheduled to retrain, deployments with auto deployment enabled will be marked to automatically promote the new model version. After the newly trained model completes, a check on its metrics in comparison to the currently deployed model version will be performed. If the metrics are comparable or better, the newly trained model version is automatically promoted. If not, it will be marked as a failed model version promotion with an error indicating poor metrics performance. - - - :param enable: Enable or disable the autoDeploy property of the deployment. - :type enable: bool - - - - .. py:method:: set_model_version(model_version, algorithm = None, model_deployment_config = None) - - Promotes a model version and/or algorithm to be the active served deployment version - - :param model_version: A unique identifier for the model version. - :type model_version: str - :param algorithm: The algorithm to use for the model version. If not specified, the algorithm will be inferred from the model version. - :type algorithm: str - :param model_deployment_config: The deployment configuration for the model to deploy. - :type model_deployment_config: dict - - - - .. py:method:: set_feature_group_version(feature_group_version) - - Promotes a feature group version to be served in the deployment. - - :param feature_group_version: Unique string identifier for the feature group version. - :type feature_group_version: str - - - - .. py:method:: set_prediction_operator_version(prediction_operator_version) - - Promotes a prediction operator version to be served in the deployment. - - :param prediction_operator_version: Unique string identifier for the prediction operator version. - :type prediction_operator_version: str - - - - .. py:method:: start() - - Restarts the specified deployment that was previously suspended. - - :param deployment_id: A unique string identifier associated with the deployment. - :type deployment_id: str - - - - .. py:method:: stop() - - Stops the specified deployment. - - :param deployment_id: Unique string identifier of the deployment to be stopped. - :type deployment_id: str - - - - .. py:method:: delete() - - Deletes the specified deployment. The deployment's models will not be affected. Note that the deployments are not recoverable after they are deleted. - - :param deployment_id: Unique string identifier of the deployment to delete. - :type deployment_id: str - - - - .. py:method:: set_feature_group_export_file_connector_output(file_format = None, output_location = None) - - Sets the export output for the Feature Group Deployment to be a file connector. - - :param file_format: The type of export output, either CSV or JSON. - :type file_format: str - :param output_location: The file connector (cloud) location where the output should be exported. - :type output_location: str - - - - .. py:method:: set_feature_group_export_database_connector_output(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) - - Sets the export output for the Feature Group Deployment to a Database connector. - - :param database_connector_id: The unique string identifier of the database connector used. - :type database_connector_id: str - :param object_name: The object of the database connector to write to. - :type object_name: str - :param write_mode: The write mode to use when writing to the database connector, either UPSERT or INSERT. - :type write_mode: str - :param database_feature_mapping: The column/feature pairs mapping the features to the database columns. - :type database_feature_mapping: dict - :param id_column: The id column to use as the upsert key. - :type id_column: str - :param additional_id_columns: For database connectors which support it, a list of additional ID columns to use as a complex key for upserting. - :type additional_id_columns: list - - - - .. py:method:: remove_feature_group_export_output() - - Removes the export type that is set for the Feature Group Deployment - - :param deployment_id: The ID of the deployment for which the export type is set. - :type deployment_id: str - - - - .. py:method:: set_default_prediction_arguments(prediction_arguments, set_as_override = False) - - Sets the deployment config. - - :param prediction_arguments: The prediction arguments to set. - :type prediction_arguments: PredictionArguments - :param set_as_override: If True, use these arguments as overrides instead of defaults for predict calls - :type set_as_override: bool - - :returns: description of the updated deployment. - :rtype: Deployment - - - - .. py:method:: create_alert(alert_name, condition_config, action_config) - - Create a deployment alert for the given conditions. - - Only support batch prediction usage now. - - - :param alert_name: Name of the alert. - :type alert_name: str - :param condition_config: Condition to run the actions for the alert. - :type condition_config: AlertConditionConfig - :param action_config: Configuration for the action of the alert. - :type action_config: AlertActionConfig - - :returns: Object describing the deployment alert. - :rtype: MonitorAlert - - - - .. py:method:: list_alerts() - - List the monitor alerts associated with the deployment id. - - :param deployment_id: Unique string identifier for the deployment. - :type deployment_id: str - - :returns: An array of deployment alerts. - :rtype: list[MonitorAlert] - - - - .. py:method:: create_realtime_monitor(realtime_monitor_schedule = None, lookback_time = None) - - Real time monitors compute and monitor metrics of real time prediction data. - - :param realtime_monitor_schedule: The cron expression for triggering monitor. - :type realtime_monitor_schedule: str - :param lookback_time: Lookback time (in seconds) for each monitor trigger - :type lookback_time: int - - :returns: Object describing the real-time monitor. - :rtype: RealtimeMonitor - - - - .. py:method:: get_conversation_response(message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, deployment_token = None, doc_infos = None) - - Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). - - :param message: A message from the user - :type message: str - :param deployment_conversation_id: The unique identifier of a deployment conversation to continue. If not specified, a new one will be created. - :type deployment_conversation_id: str - :param external_session_id: The user supplied unique identifier of a deployment conversation to continue. If specified, we will use this instead of a internal deployment conversation id. - :type external_session_id: str - :param llm_name: Name of the specific LLM backend to use to power the chat experience - :type llm_name: str - :param num_completion_tokens: Default for maximum number of tokens for chat answers - :type num_completion_tokens: int - :param system_message: The generative LLM system message - :type system_message: str - :param temperature: The generative LLM temperature - :type temperature: float - :param filter_key_values: A dictionary mapping column names to a list of values to restrict the retrived search results. - :type filter_key_values: dict - :param search_score_cutoff: Cutoff for the document retriever score. Matching search results below this score will be ignored. - :type search_score_cutoff: float - :param chat_config: A dictionary specifiying the query chat config override. - :type chat_config: dict - :param ignore_documents: If True, will ignore any documents and search results, and only use the message and past conversation to generate a response. - :type ignore_documents: bool - :param deployment_token: A token used to authenticate access to deployments created in this project. This token is only authorized to predict on deployments in this project, so it is safe to embed this model inside of an application or website. - :type deployment_token: str - :param doc_infos: An optional list of documents use for the conversation. A keyword 'doc_id' is expected to be present in each document for retrieving contents from docstore. - :type doc_infos: list - - - - .. py:method:: get_conversation_response_with_binary_data(deployment_token, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) - - Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). - - :param deployment_token: A token used to authenticate access to deployments created in this project. This token is only authorized to predict on deployments in this project, so it is safe to embed this model inside of an application or website. - :type deployment_token: str - :param message: A message from the user - :type message: str - :param deployment_conversation_id: The unique identifier of a deployment conversation to continue. If not specified, a new one will be created. - :type deployment_conversation_id: str - :param external_session_id: The user supplied unique identifier of a deployment conversation to continue. If specified, we will use this instead of a internal deployment conversation id. - :type external_session_id: str - :param llm_name: Name of the specific LLM backend to use to power the chat experience - :type llm_name: str - :param num_completion_tokens: Default for maximum number of tokens for chat answers - :type num_completion_tokens: int - :param system_message: The generative LLM system message - :type system_message: str - :param temperature: The generative LLM temperature - :type temperature: float - :param filter_key_values: A dictionary mapping column names to a list of values to restrict the retrived search results. - :type filter_key_values: dict - :param search_score_cutoff: Cutoff for the document retriever score. Matching search results below this score will be ignored. - :type search_score_cutoff: float - :param chat_config: A dictionary specifiying the query chat config override. - :type chat_config: dict - :param ignore_documents: If True, will ignore any documents and search results, and only use the message and past conversation to generate a response. - :type ignore_documents: bool - :param attachments: A dictionary of binary data to use to answer the queries. - :type attachments: None - - - - .. py:method:: create_batch_prediction(table_name = None, name = None, global_prediction_args = None, batch_prediction_args = None, explanations = False, output_format = None, output_location = None, database_connector_id = None, database_output_config = None, refresh_schedule = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, input_feature_groups = None) - - Creates a batch prediction job description for the given deployment. - - :param table_name: Name of the feature group table to write the results of the batch prediction. Can only be specified if outputLocation and databaseConnectorId are not specified. If tableName is specified, the outputType will be enforced as CSV. - :type table_name: str - :param name: Name of the batch prediction job. - :type name: str - :param batch_prediction_args: Batch Prediction args specific to problem type. - :type batch_prediction_args: BatchPredictionArgs - :param output_format: Format of the batch prediction output (CSV or JSON). - :type output_format: str - :param output_location: Location to write the prediction results. Otherwise, results will be stored in Abacus.AI. - :type output_location: str - :param database_connector_id: Unique identifier of a Database Connection to write predictions to. Cannot be specified in conjunction with outputLocation. - :type database_connector_id: str - :param database_output_config: Key-value pair of columns/values to write to the database connector. Only available if databaseConnectorId is specified. - :type database_output_config: dict - :param refresh_schedule: Cron-style string that describes a schedule in UTC to automatically run the batch prediction. - :type refresh_schedule: str - :param csv_input_prefix: Prefix to prepend to the input columns, only applies when output format is CSV. - :type csv_input_prefix: str - :param csv_prediction_prefix: Prefix to prepend to the prediction columns, only applies when output format is CSV. - :type csv_prediction_prefix: str - :param csv_explanations_prefix: Prefix to prepend to the explanation columns, only applies when output format is CSV. - :type csv_explanations_prefix: str - :param output_includes_metadata: If true, output will contain columns including prediction start time, batch prediction version, and model version. - :type output_includes_metadata: bool - :param result_input_columns: If present, will limit result files or feature groups to only include columns present in this list. - :type result_input_columns: list - :param input_feature_groups: A dict of {'': ''} which overrides the default input data of that type for the Batch Prediction. Default input data is the training data that was used for training the deployed model. - :type input_feature_groups: dict - - :returns: The batch prediction description. - :rtype: BatchPrediction - - - - .. py:method:: describe_feature_group_row_process_by_key(primary_key_value) - - Gets the feature group row process. - - :param primary_key_value: The primary key value - :type primary_key_value: str - - :returns: An object representing the feature group row process - :rtype: FeatureGroupRowProcess - - - - .. py:method:: list_feature_group_row_processes(limit = None, status = None) - - Gets a list of feature group row processes. - - :param limit: The maximum number of processes to return. Defaults to None. - :type limit: int - :param status: The status of the processes to return. Defaults to None. - :type status: str - - :returns: A list of object representing the feature group row process - :rtype: list[FeatureGroupRowProcess] - - - - .. py:method:: get_feature_group_row_process_summary() - - Gets a summary of the statuses of the individual feature group processes. - - :param deployment_id: The deployment id for the process - :type deployment_id: str - - :returns: An object representing the summary of the statuses of the individual feature group processes - :rtype: FeatureGroupRowProcessSummary - - - - .. py:method:: reset_feature_group_row_process_by_key(primary_key_value) - - Resets a feature group row process so that it can be reprocessed - - :param primary_key_value: The primary key value - :type primary_key_value: str - - :returns: An object representing the feature group row process. - :rtype: FeatureGroupRowProcess - - - - .. py:method:: get_feature_group_row_process_logs_by_key(primary_key_value) - - Gets the logs for a feature group row process - - :param primary_key_value: The primary key value - :type primary_key_value: str - - :returns: An object representing the logs for the feature group row process - :rtype: FeatureGroupRowProcessLogs - - - - .. py:method:: create_conversation(name, deployment_token = None, external_application_id = None) - - Creates a deployment conversation. - - :param name: The name of the conversation. - :type name: str - :param deployment_token: The deployment token to authenticate access to the deployment. This is required if not logged in. - :type deployment_token: str - :param external_application_id: The external application id associated with the deployment conversation. - :type external_application_id: str - - :returns: The deployment conversation. - :rtype: DeploymentConversation - - - - .. py:method:: list_conversations(external_application_id = None) - - Lists all conversations for the given deployment and current user. - - :param external_application_id: The external application id associated with the deployment conversation. If specified, only conversations created on that application will be listed. - :type external_application_id: str - - :returns: The deployment conversations. - :rtype: list[DeploymentConversation] - - - - .. py:method:: create_external_application(name = None, description = None, logo = None, theme = None) - - Creates a new External Application from an existing ChatLLM Deployment. - - :param name: The name of the External Application. If not provided, the name of the deployment will be used. - :type name: str - :param description: The description of the External Application. This will be shown to users when they access the External Application. If not provided, the description of the deployment will be used. - :type description: str - :param logo: The logo to be displayed. - :type logo: str - :param theme: The visual theme of the External Application. - :type theme: dict - - :returns: The newly created External Application. - :rtype: ExternalApplication - - - - .. py:method:: download_agent_attachment(attachment_id) - - Return an agent attachment. - - :param attachment_id: The attachment ID. - :type attachment_id: str - - - - .. py:method:: wait_for_deployment(wait_states={'PENDING', 'DEPLOYING'}, timeout=900) - - A waiting call until deployment is completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_pending_deployment_update(timeout=900) - - A waiting call until deployment is in a stable state, that pending model switch is completed and previous model is stopped. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - :returns: the latest deployment object. - :rtype: Deployment - - - - .. py:method:: get_status() - - Gets the status of the deployment. - - :returns: A string describing the status of a deploymet (pending, deploying, active, etc.). - :rtype: str - - - - .. py:method:: create_refresh_policy(cron) - - To create a refresh policy for a deployment. - - :param cron: A cron style string to set the refresh time. - :type cron: str - - :returns: The refresh policy object. - :rtype: RefreshPolicy - - - - .. py:method:: list_refresh_policies() - - Gets the refresh policies in a list. - - :returns: A list of refresh policy objects. - :rtype: List[RefreshPolicy] - - - -.. py:class:: DeploymentAuthToken(client, deploymentToken=None, createdAt=None, name=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A deployment authentication token that is used to authenticate prediction requests - - :param client: An authenticated API Client instance - :type client: ApiClient - :param deploymentToken: The unique token used to authenticate requests. - :type deploymentToken: str - :param createdAt: The date and time when the token was created, in ISO-8601 format. - :type createdAt: str - :param name: The name associated with the authentication token. - :type name: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DeploymentConversation(client, deploymentConversationId=None, name=None, deploymentId=None, createdAt=None, lastEventCreatedAt=None, externalSessionId=None, regenerateAttempt=None, externalApplicationId=None, history={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A deployment conversation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param deploymentConversationId: The unique identifier of the deployment conversation. - :type deploymentConversationId: str - :param name: The name of the deployment conversation. - :type name: str - :param deploymentId: The deployment id associated with the deployment conversation. - :type deploymentId: str - :param createdAt: The timestamp at which the deployment conversation was created. - :type createdAt: str - :param lastEventCreatedAt: The timestamp at which the most recent corresponding deployment conversation event was created at. - :type lastEventCreatedAt: str - :param externalSessionId: The external session id associated with the deployment conversation. - :type externalSessionId: str - :param regenerateAttempt: The sequence number of regeneration. Not regenerated if 0. - :type regenerateAttempt: int - :param externalApplicationId: The external application id associated with the deployment conversation. - :type externalApplicationId: str - :param history: The history of the deployment conversation. - :type history: DeploymentConversationEvent - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get(external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True) - - Gets a deployment conversation. - - :param external_session_id: External session ID of the conversation. - :type external_session_id: str - :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. - :type deployment_id: str - :param deployment_token: The deployment token to authenticate access to the deployment. This is required if not logged in. - :type deployment_token: str - :param filter_intermediate_conversation_events: If true, intermediate conversation events will be filtered out. Default is true. - :type filter_intermediate_conversation_events: bool - - :returns: The deployment conversation. - :rtype: DeploymentConversation - - - - .. py:method:: delete(deployment_id = None, deployment_token = None) - - Delete a Deployment Conversation. - - :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. - :type deployment_id: str - :param deployment_token: The deployment token to authenticate access to the deployment. This is required if not logged in. - :type deployment_token: str - - - - .. py:method:: clear(external_session_id = None, deployment_id = None, deployment_token = None, user_message_indices = None) - - Clear the message history of a Deployment Conversation. - - :param external_session_id: The external session id associated with the deployment conversation. - :type external_session_id: str - :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. - :type deployment_id: str - :param deployment_token: The deployment token to authenticate access to the deployment. This is required if not logged in. - :type deployment_token: str - :param user_message_indices: Optional list of user message indices to clear. The associated bot response will also be cleared. If not provided, all messages will be cleared. - :type user_message_indices: list - - - - .. py:method:: set_feedback(message_index, is_useful = None, is_not_useful = None, feedback = None, feedback_type = None, deployment_id = None, deployment_token = None) - - Sets a deployment conversation message as useful or not useful - - :param message_index: The index of the deployment conversation message - :type message_index: int - :param is_useful: If the message is useful. If true, the message is useful. If false, clear the useful flag. - :type is_useful: bool - :param is_not_useful: If the message is not useful. If true, the message is not useful. If set to false, clear the useful flag. - :type is_not_useful: bool - :param feedback: Optional feedback on why the message is useful or not useful - :type feedback: str - :param feedback_type: Optional feedback type - :type feedback_type: str - :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. - :type deployment_id: str - :param deployment_token: The deployment token to authenticate access to the deployment. This is required if not logged in. - :type deployment_token: str - - - - .. py:method:: rename(name, deployment_id = None, deployment_token = None) - - Rename a Deployment Conversation. - - :param name: The new name of the conversation. - :type name: str - :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. - :type deployment_id: str - :param deployment_token: The deployment token to authenticate access to the deployment. This is required if not logged in. - :type deployment_token: str - - - - .. py:method:: export(external_session_id = None) - - Export a Deployment Conversation. - - :param external_session_id: The external session id associated with the deployment conversation. One of deployment_conversation_id or external_session_id must be provided. - :type external_session_id: str - - :returns: The deployment conversation html export. - :rtype: DeploymentConversationExport - - - -.. py:class:: DeploymentConversationExport(client, deploymentConversationId=None, conversationExportHtml=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A deployment conversation html export, to be used for downloading the conversation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param deploymentConversationId: The unique identifier of the deployment conversation. - :type deploymentConversationId: str - :param conversationExportHtml: The html string of the deployment conversation. - :type conversationExportHtml: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DocumentData(client, docId=None, mimeType=None, pageCount=None, totalPageCount=None, extractedText=None, embeddedText=None, pages=None, tokens=None, metadata=None, pageMarkdown=None, extractedPageText=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Data extracted from a docstore document. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param docId: Unique Docstore string identifier for the document. - :type docId: str - :param mimeType: The mime type of the document. - :type mimeType: str - :param pageCount: The number of pages for which the data is available. This is generally same as the total number of pages but may be less than the total number of pages in the document if processing is done only for selected pages. - :type pageCount: int - :param totalPageCount: The total number of pages in the document. - :type totalPageCount: int - :param extractedText: The extracted text in the document obtained from OCR. - :type extractedText: str - :param embeddedText: The embedded text in the document. Only available for digital documents. - :type embeddedText: str - :param pages: List of embedded text for each page in the document. Only available for digital documents. - :type pages: list - :param tokens: List of extracted tokens in the document obtained from OCR. - :type tokens: list - :param metadata: List of metadata for each page in the document. - :type metadata: list - :param pageMarkdown: The markdown text for the page. - :type pageMarkdown: list - :param extractedPageText: List of extracted text for each page in the document obtained from OCR. - :type extractedPageText: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DocumentRetriever(client, name=None, documentRetrieverId=None, createdAt=None, featureGroupId=None, featureGroupName=None, indexingRequired=None, latestDocumentRetrieverVersion={}, documentRetrieverConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A vector store that stores embeddings for a list of document trunks. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the document retriever. - :type name: str - :param documentRetrieverId: The unique identifier of the vector store. - :type documentRetrieverId: str - :param createdAt: When the vector store was created. - :type createdAt: str - :param featureGroupId: The feature group id associated with the document retriever. - :type featureGroupId: str - :param featureGroupName: The feature group name associated with the document retriever. - :type featureGroupName: str - :param indexingRequired: Whether the document retriever is required to be indexed due to changes in underlying data. - :type indexingRequired: bool - :param latestDocumentRetrieverVersion: The latest version of vector store. - :type latestDocumentRetrieverVersion: DocumentRetrieverVersion - :param documentRetrieverConfig: The config for vector store creation. - :type documentRetrieverConfig: DocumentRetrieverConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: rename(name) - - Updates an existing document retriever. - - :param name: The name to update the document retriever with. - :type name: str - - :returns: The updated document retriever. - :rtype: DocumentRetriever - - - - .. py:method:: create_version(feature_group_id = None, document_retriever_config = None) - - Creates a document retriever version from the latest version of the feature group that the document retriever associated with. - - :param feature_group_id: The ID of the feature group to update the document retriever with. - :type feature_group_id: str - :param document_retriever_config: The configuration, including chunk_size and chunk_overlap_fraction, for document retrieval. - :type document_retriever_config: VectorStoreConfig - - :returns: The newly created document retriever version. - :rtype: DocumentRetrieverVersion - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DocumentRetriever - - - - .. py:method:: describe() - - Describe a Document Retriever. - - :param document_retriever_id: A unique string identifier associated with the document retriever. - :type document_retriever_id: str - - :returns: The document retriever object. - :rtype: DocumentRetriever - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - List all the document retriever versions with a given ID. - - :param limit: The number of vector store versions to retrieve. - :type limit: int - :param start_after_version: An offset parameter to exclude all document retriever versions up to this specified one. - :type start_after_version: str - - :returns: All the document retriever versions associated with the document retriever. - :rtype: list[DocumentRetrieverVersion] - - - - .. py:method:: get_document_snippet(document_id, start_word_index = None, end_word_index = None) - - Get a snippet from documents in the document retriever. - - :param document_id: The ID of the document to retrieve the snippet from. - :type document_id: str - :param start_word_index: If provided, will start the snippet at the index (of words in the document) specified. - :type start_word_index: int - :param end_word_index: If provided, will end the snippet at the index of (of words in the document) specified. - :type end_word_index: int - - :returns: The documentation snippet found from the document retriever. - :rtype: DocumentRetrieverLookupResult - - - - .. py:method:: restart() - - Restart the document retriever if it is stopped. This will start the deployment of the document retriever, - - but will not wait for it to be ready. You need to call wait_until_ready to wait until the deployment is ready. - - - :param document_retriever_id: A unique string identifier associated with the document retriever. - :type document_retriever_id: str - - - - .. py:method:: wait_until_ready(timeout = 3600) - - A waiting call until document retriever is ready. It restarts the document retriever if it is stopped. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 3600 seconds. - :type timeout: int - - - - .. py:method:: wait_until_deployment_ready(timeout = 3600) - - A waiting call until the document retriever deployment is ready to serve. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 3600 seconds. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the indexing status of the document retriever. - - :returns: A string describing the status of a document retriever (pending, complete, etc.). - :rtype: str - - - - .. py:method:: get_deployment_status() - - Gets the deployment status of the document retriever. - - :returns: A string describing the deployment status of document retriever (pending, deploying, active, etc.). - :rtype: str - - - - .. py:method:: get_matching_documents(query, filters = None, limit = None, result_columns = None, max_words = None, num_retrieval_margin_words = None, max_words_per_chunk = None, score_multiplier_column = None, min_score = None, required_phrases = None, filter_clause = None, crowding_limits = None) - - Lookup document retrievers and return the matching documents from the document retriever deployed with given query. - - Original documents are split into chunks and stored in the document retriever. This lookup function will return the relevant chunks - from the document retriever. The returned chunks could be expanded to include more words from the original documents and merged if they - are overlapping, and permitted by the settings provided. The returned chunks are sorted by relevance. - - - :param query: The query to search for. - :type query: str - :param filters: A dictionary mapping column names to a list of values to restrict the retrieved search results. - :type filters: dict - :param limit: If provided, will limit the number of results to the value specified. - :type limit: int - :param result_columns: If provided, will limit the column properties present in each result to those specified in this list. - :type result_columns: list - :param max_words: If provided, will limit the total number of words in the results to the value specified. - :type max_words: int - :param num_retrieval_margin_words: If provided, will add this number of words from left and right of the returned chunks. - :type num_retrieval_margin_words: int - :param max_words_per_chunk: If provided, will limit the number of words in each chunk to the value specified. If the value provided is smaller than the actual size of chunk on disk, which is determined during document retriever creation, the actual size of chunk will be used. I.e, chunks looked up from document retrievers will not be split into smaller chunks during lookup due to this setting. - :type max_words_per_chunk: int - :param score_multiplier_column: If provided, will use the values in this column to modify the relevance score of the returned chunks. Values in this column must be numeric. - :type score_multiplier_column: str - :param min_score: If provided, will filter out the results with score lower than the value specified. - :type min_score: float - :param required_phrases: If provided, each result will have at least one of the phrases. - :type required_phrases: list - :param filter_clause: If provided, filter the results of the query using this sql where clause. - :type filter_clause: str - :param crowding_limits: A dictionary mapping metadata columns to the maximum number of results per unique value of the column. This is used to ensure diversity of metadata attribute values in the results. If a particular attribute value has already reached its maximum count, further results with that same attribute value will be excluded from the final result set. - :type crowding_limits: dict - - :returns: The relevant documentation results found from the document retriever. - :rtype: list[DocumentRetrieverLookupResult] - - - -.. py:class:: DocumentRetrieverLookupResult(client, document=None, score=None, properties=None, pages=None, boundingBoxes=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Result of a document retriever lookup. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param document: The document that was looked up. - :type document: str - :param score: Score of the document with respect to the query. - :type score: float - :param properties: Properties of the retrieved documents. - :type properties: dict - :param pages: Pages of the retrieved text from the original document. - :type pages: list - :param boundingBoxes: Bounding boxes of the retrieved text from the original document. - :type boundingBoxes: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DocumentRetrieverVersion(client, documentRetrieverId=None, documentRetrieverVersion=None, createdAt=None, status=None, deploymentStatus=None, featureGroupId=None, featureGroupVersion=None, error=None, numberOfChunks=None, embeddingFileSize=None, warnings=None, resolvedConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of document retriever. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param documentRetrieverId: The unique identifier of the Document Retriever. - :type documentRetrieverId: str - :param documentRetrieverVersion: The unique identifier of the Document Retriever version. - :type documentRetrieverVersion: str - :param createdAt: When the Document Retriever was created. - :type createdAt: str - :param status: The status of creating Document Retriever version. - :type status: str - :param deploymentStatus: The status of deploying the Document Retriever version. - :type deploymentStatus: str - :param featureGroupId: The feature group id associated with the document retriever. - :type featureGroupId: str - :param featureGroupVersion: The unique identifier of the feature group version at which the Document Retriever version is created. - :type featureGroupVersion: str - :param error: The error message when it failed to create the document retriever version. - :type error: str - :param numberOfChunks: The number of chunks for the document retriever. - :type numberOfChunks: int - :param embeddingFileSize: The size of embedding file for the document retriever. - :type embeddingFileSize: int - :param warnings: The warning messages when creating the document retriever. - :type warnings: list - :param resolvedConfig: The resolved configurations, such as default settings, for indexing documents. - :type resolvedConfig: DocumentRetrieverConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DocumentRetrieverVersion - - - - .. py:method:: describe() - - Describe a document retriever version. - - :param document_retriever_version: A unique string identifier associated with the document retriever version. - :type document_retriever_version: str - - :returns: The document retriever version object. - :rtype: DocumentRetrieverVersion - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until document retriever version is complete. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_until_ready(timeout=3600) - - A waiting call until the document retriever version is ready. It restarts the document retriever if it is stopped. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_until_deployment_ready(timeout = 3600) - - A waiting call until the document retriever deployment is ready to serve. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 3600 seconds. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the document retriever version. - - :returns: A string describing the status of a document retriever version (pending, complete, etc.). - :rtype: str - - - - .. py:method:: get_deployment_status() - - Gets the status of the document retriever version. - - :returns: A string describing the deployment status of a document retriever version (pending, deploying, etc.). - :rtype: str - - - -.. py:class:: DriftDistributions(client, labelDrift={}, predictionDrift={}, bpPredictionDrift={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - For either actuals or predicted values, how it has changed in the training data versus some specified window - - :param client: An authenticated API Client instance - :type client: ApiClient - :param labelDrift: A DriftDistribution describing column names and the range of values for label drift. - :type labelDrift: DriftDistribution - :param predictionDrift: A DriftDistribution describing column names and the range of values for prediction drift. - :type predictionDrift: DriftDistribution - :param bpPredictionDrift: A DriftDistribution describing column names and the range of values for prediction drift, when the predictions come from BP. - :type bpPredictionDrift: DriftDistribution - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Eda(client, edaId=None, name=None, createdAt=None, projectId=None, featureGroupId=None, referenceFeatureGroupVersion=None, testFeatureGroupVersion=None, edaConfigs=None, latestEdaVersion={}, refreshSchedules={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A exploratory data analysis object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param edaId: The unique identifier of the eda object. - :type edaId: str - :param name: The user-friendly name for the eda object. - :type name: str - :param createdAt: Date and time at which the eda object was created. - :type createdAt: str - :param projectId: The project this eda object belongs to. - :type projectId: str - :param featureGroupId: Feature group ID for which eda analysis is being done. - :type featureGroupId: str - :param referenceFeatureGroupVersion: Reference Feature group version for data consistency analysis, will be latest feature group version for collinearity analysis. - :type referenceFeatureGroupVersion: str - :param testFeatureGroupVersion: Test Feature group version for data consistency analysis, will be latest feature group version for collinearity analysis. - :type testFeatureGroupVersion: str - :param edaConfigs: Configurations for eda object. - :type edaConfigs: dict - :param latestEdaVersion: The latest eda object version. - :type latestEdaVersion: EdaVersion - :param refreshSchedules: List of refresh schedules that indicate when the next model version will be trained. - :type refreshSchedules: RefreshSchedule - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: rerun() - - Reruns the specified EDA object. - - :param eda_id: Unique string identifier of the EDA object to rerun. - :type eda_id: str - - :returns: The EDA object that is being rerun. - :rtype: Eda - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Eda - - - - .. py:method:: describe() - - Retrieves a full description of the specified EDA object. - - :param eda_id: Unique string identifier associated with the EDA object. - :type eda_id: str - - :returns: Description of the EDA object. - :rtype: Eda - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of versions for a given EDA object. - - :param limit: The maximum length of the list of all EDA versions. - :type limit: int - :param start_after_version: The ID of the version after which the list starts. - :type start_after_version: str - - :returns: A list of EDA versions. - :rtype: list[EdaVersion] - - - - .. py:method:: rename(name) - - Renames an EDA - - :param name: The new name to apply to the model monitor. - :type name: str - - - - .. py:method:: delete() - - Deletes the specified EDA and all its versions. - - :param eda_id: Unique string identifier of the EDA to delete. - :type eda_id: str - - - -.. py:class:: EdaCollinearity(client, columnNames=None, collinearityMatrix=None, groupFeatureDict=None, collinearityGroups=None, columnNamesX=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Eda Collinearity of the latest version of the data between all the features. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param columnNames: Name of all the features in the y axis of the collinearity matrix - :type columnNames: list - :param collinearityMatrix: A dict describing the collinearity between all the features - :type collinearityMatrix: dict - :param groupFeatureDict: A dict describing the index of the group from collinearity_groups a feature exists in - :type groupFeatureDict: dict - :param collinearityGroups: Groups created based on a collinearity threshold of 0.7 - :type collinearityGroups: list - :param columnNamesX: Name of all the features in the x axis of the collinearity matrix - :type columnNamesX: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: EdaDataConsistency(client, columnNames=None, primaryKeys=None, transformationColumnNames=None, baseDuplicates={}, compareDuplicates={}, deletions={}, transformations={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Eda Data Consistency, contained the duplicates in the base version, Comparison version, Deletions between the base and comparison and feature transformations between the base and comparison data. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param columnNames: Name of all the features in the data - :type columnNames: list - :param primaryKeys: Name of the primary keys in the data - :type primaryKeys: list - :param transformationColumnNames: Name of all the features that are not the primary keys - :type transformationColumnNames: list - :param baseDuplicates: A DataConsistencyDuplication describing the number of duplicates within the data - :type baseDuplicates: DataConsistencyDuplication - :param compareDuplicates: A DataConsistencyDuplication describing the number of duplicates within the data - :type compareDuplicates: DataConsistencyDuplication - :param deletions: A DataConsistencyDeletion describing the number of deletion between two versions in the data - :type deletions: DataConsistencyDuplication - :param transformations: A DataConsistencyTransformation the number of changes that occured per feature in the data - :type transformations: DataConsistencyTransformation - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: EdaFeatureAssociation(client, data=None, isScatter=None, isBoxWhisker=None, xAxis=None, yAxis=None, xAxisColumnValues=None, yAxisColumnValues=None, dataColumns=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Eda Feature Association between two features in the data. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param data: the data to display the feature association between two features - :type data: dict - :param isScatter: A Boolean that represents if the data creates a scatter plot (for cases of numerical data vs numerical data) - :type isScatter: bool - :param isBoxWhisker: A Boolean that represents if the data creates a box whisker plot (For cases of categorical data vs numerical data and vice versa) - :type isBoxWhisker: bool - :param xAxis: Name of the feature selected for feature association (reference_feature_name) for x axis on the plot - :type xAxis: str - :param yAxis: Name of the feature selected for feature association (test_feature_name) for y axis on the plot - :type yAxis: str - :param xAxisColumnValues: Name of all the categories within the x_axis feature (if it is a categorical data type) - :type xAxisColumnValues: list - :param yAxisColumnValues: Name of all the categories within the y_axis feature (if it is a categorical data type) - :type yAxisColumnValues: list - :param dataColumns: A list of columns listed in the data as keys - :type dataColumns: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: EdaFeatureCollinearity(client, selectedFeature=None, sortedColumnNames=None, featureCollinearity=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Eda Collinearity of the latest version of the data for a given feature. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param selectedFeature: Selected feature to show the collinearity - :type selectedFeature: str - :param sortedColumnNames: Name of all the features in the data sorted in descending order of collinearity value - :type sortedColumnNames: list - :param featureCollinearity: A dict describing the collinearity between a given feature and all the features in the data - :type featureCollinearity: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: EdaForecastingAnalysis(client, primaryKeys=None, forecastingTargetFeature=None, timestampFeature=None, forecastFrequency=None, salesAcrossTime={}, cummulativeContribution={}, missingValueDistribution={}, historyLength={}, numRowsHistogram={}, productMaturity={}, seasonalityYear={}, seasonalityMonth={}, seasonalityWeekOfYear={}, seasonalityDayOfYear={}, seasonalityDayOfMonth={}, seasonalityDayOfWeek={}, seasonalityQuarter={}, seasonalityHour={}, seasonalityMinute={}, seasonalitySecond={}, autocorrelation={}, partialAutocorrelation={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Eda Forecasting Analysis of the latest version of the data. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param primaryKeys: Name of the primary keys in the data - :type primaryKeys: list - :param forecastingTargetFeature: Feature in the data that represents the target. - :type forecastingTargetFeature: str - :param timestampFeature: Feature in the data that represents the timestamp column. - :type timestampFeature: str - :param forecastFrequency: Frequency of data, could be hourly, daily, weekly, monthly, quarterly or yearly. - :type forecastFrequency: str - :param salesAcrossTime: Data showing average, p10, p90, median sales across time - :type salesAcrossTime: ForecastingAnalysisGraphData - :param cummulativeContribution: Data showing what percent of items contribute to what amount of sales. - :type cummulativeContribution: ForecastingAnalysisGraphData - :param missingValueDistribution: Data showing missing or null value distribution - :type missingValueDistribution: ForecastingAnalysisGraphData - :param historyLength: Data showing length of history distribution - :type historyLength: ForecastingAnalysisGraphData - :param numRowsHistogram: Data showing number of rows for an item distribution - :type numRowsHistogram: ForecastingAnalysisGraphData - :param productMaturity: Data showing length of how long a product has been alive with average, p10, p90 and median - :type productMaturity: ForecastingAnalysisGraphData - :param seasonalityYear: Data showing average, p10, p90, median sales across grouped years - :type seasonalityYear: ForecastingAnalysisGraphData - :param seasonalityMonth: Data showing average, p10, p90, median sales across grouped months - :type seasonalityMonth: ForecastingAnalysisGraphData - :param seasonalityWeekOfYear: Data showing average, p10, p90, median sales across week of year seasonality - :type seasonalityWeekOfYear: ForecastingAnalysisGraphData - :param seasonalityDayOfYear: Data showing average, p10, p90, median sales across day of year seasonality - :type seasonalityDayOfYear: ForecastingAnalysisGraphData - :param seasonalityDayOfMonth: Data showing average, p10, p90, median sales across day of month seasonality - :type seasonalityDayOfMonth: ForecastingAnalysisGraphData - :param seasonalityDayOfWeek: Data showing average, p10, p90, median sales across day of week seasonality - :type seasonalityDayOfWeek: ForecastingAnalysisGraphData - :param seasonalityQuarter: Data showing average, p10, p90, median sales across grouped quarters - :type seasonalityQuarter: ForecastingAnalysisGraphData - :param seasonalityHour: Data showing average, p10, p90, median sales across grouped hours - :type seasonalityHour: ForecastingAnalysisGraphData - :param seasonalityMinute: Data showing average, p10, p90, median sales across grouped minutes - :type seasonalityMinute: ForecastingAnalysisGraphData - :param seasonalitySecond: Data showing average, p10, p90, median sales across grouped seconds - :type seasonalitySecond: ForecastingAnalysisGraphData - :param autocorrelation: Data showing the correlation of the forecasting target and its lagged values at different time lags. - :type autocorrelation: ForecastingAnalysisGraphData - :param partialAutocorrelation: Data showing the correlation of the forecasting target and its lagged values, controlling for the effects of intervening lags. - :type partialAutocorrelation: ForecastingAnalysisGraphData - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: EdaVersion(client, edaVersion=None, status=None, edaId=None, edaStartedAt=None, edaCompletedAt=None, referenceFeatureGroupVersion=None, testFeatureGroupVersion=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of an eda object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param edaVersion: The unique identifier of a eda version. - :type edaVersion: str - :param status: The current status of the eda object. - :type status: str - :param edaId: A reference to the eda this version belongs to. - :type edaId: str - :param edaStartedAt: The start time and date of the eda process. - :type edaStartedAt: str - :param edaCompletedAt: The end time and date of the eda process. - :type edaCompletedAt: str - :param referenceFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is analyzing. - :type referenceFeatureGroupVersion: list[str] - :param testFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is analyzing. - :type testFeatureGroupVersion: list[str] - :param error: Relevant error if the status is FAILED. - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: EdaVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified EDA version. - - :param eda_version: Unique string identifier of the EDA version. - :type eda_version: str - - :returns: An EDA version. - :rtype: EdaVersion - - - - .. py:method:: delete() - - Deletes the specified EDA version. - - :param eda_version: Unique string identifier of the EDA version to delete. - :type eda_version: str - - - - .. py:method:: get_eda_collinearity() - - Gets the Collinearity between all features for the Exploratory Data Analysis. - - :param eda_version: Unique string identifier associated with the EDA instance. - :type eda_version: str - - :returns: An object with a record of correlations between each feature for the EDA. - :rtype: EdaCollinearity - - - - .. py:method:: get_eda_data_consistency(transformation_feature = None) - - Gets the data consistency for the Exploratory Data Analysis. - - :param transformation_feature: The transformation feature to get consistency for. - :type transformation_feature: str - - :returns: Object with duplication, deletion, and transformation data for data consistency analysis for an EDA. - :rtype: EdaDataConsistency - - - - .. py:method:: get_collinearity_for_feature(feature_name = None) - - Gets the Collinearity for the given feature from the Exploratory Data Analysis. - - :param feature_name: Name of the feature for which correlation is shown. - :type feature_name: str - - :returns: Object with a record of correlations for the provided feature for an EDA. - :rtype: EdaFeatureCollinearity - - - - .. py:method:: get_feature_association(reference_feature_name, test_feature_name) - - Gets the Feature Association for the given features from the feature group version within the eda_version. - - :param reference_feature_name: Name of the feature for feature association (on x-axis for the plots generated for the Feature association in the product). - :type reference_feature_name: str - :param test_feature_name: Name of the feature for feature association (on y-axis for the plots generated for the Feature association in the product). - :type test_feature_name: str - - :returns: An object with a record of data for the feature association between the two given features for an EDA version. - :rtype: EdaFeatureAssociation - - - - .. py:method:: get_eda_forecasting_analysis() - - Gets the Forecasting analysis for the Exploratory Data Analysis. - - :param eda_version: Unique string identifier associated with the EDA version. - :type eda_version: str - - :returns: Object with forecasting analysis that includes sales_across_time, cummulative_contribution, missing_value_distribution, history_length, num_rows_histogram, product_maturity data. - :rtype: EdaForecastingAnalysis - - - - .. py:method:: wait_for_eda(timeout=1200) - - A waiting call until eda version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the eda version. - - :returns: A string describing the status of the model monitor version, for e.g., pending, complete, etc. - :rtype: str - - - -.. py:class:: ExecuteFeatureGroupOperation(client, featureGroupOperationRunId=None, status=None, error=None, query=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The result of executing a SQL query - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupOperationRunId: The run id of the operation - :type featureGroupOperationRunId: str - :param status: The status of the operation - :type status: str - :param error: The error message if the operation failed - :type error: str - :param query: The SQL query of the operation - :type query: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: wait_for_results(timeout=3600, delay=2) - - A waiting call until query is executed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - :param delay: Polling interval for checking timeout. - :type delay: int - - - - .. py:method:: wait_for_execution(timeout=3600, delay=2) - - A waiting call until query is executed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - :param delay: Polling interval for checking timeout. - :type delay: int - - - - .. py:method:: get_status() - - Gets the status of the query execution - - :returns: A string describing the status of a query execution (pending, complete, etc.). - :rtype: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DatasetVersion - - - - .. py:method:: describe() - - Gets the description of the query execution - - :returns: A ExecuteFeatureGroupOperation object describing the query execution. - :rtype: ExecuteFeatureGroupOperation - - - - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) - - - .. py:method:: load_as_pandas(max_workers=10) - - Loads the result data into a pandas dataframe - - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe displaying the data from execution. - :rtype: DataFrame - - - -.. py:class:: ExternalApplication(client, name=None, externalApplicationId=None, deploymentId=None, description=None, logo=None, theme=None, userGroupIds=None, useCase=None, status=None, deploymentConversationRetentionHours=None, managedUserService=None, predictionOverrides=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An external application. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the external application. - :type name: str - :param externalApplicationId: The unique identifier of the external application. - :type externalApplicationId: str - :param deploymentId: The deployment id associated with the external application. - :type deploymentId: str - :param description: The description of the external application. - :type description: str - :param logo: The logo. - :type logo: str - :param theme: The theme used for the External Application. - :type theme: dict - :param userGroupIds: A list of App User Groups with access to this external application - :type userGroupIds: list - :param useCase: Use Case of the project of this deployment - :type useCase: str - :param status: The status of the deployment. - :type status: str - :param deploymentConversationRetentionHours: The retention policy for the external application. - :type deploymentConversationRetentionHours: int - :param managedUserService: The external service that is managing the user accounts. - :type managedUserService: str - :param predictionOverrides: The prediction overrides for the external application. - :type predictionOverrides: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: update(name = None, description = None, theme = None, deployment_id = None, deployment_conversation_retention_hours = None, reset_retention_policy = False) - - Updates an External Application. - - :param name: The name of the External Application. - :type name: str - :param description: The description of the External Application. This will be shown to users when they access the External Application. - :type description: str - :param theme: The visual theme of the External Application. - :type theme: dict - :param deployment_id: The ID of the deployment to use. - :type deployment_id: str - :param deployment_conversation_retention_hours: The number of hours to retain the conversations for. - :type deployment_conversation_retention_hours: int - :param reset_retention_policy: If true, the retention policy will be removed. - :type reset_retention_policy: bool - - :returns: The updated External Application. - :rtype: ExternalApplication - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ExternalApplication - - - - .. py:method:: describe() - - Describes an External Application. - - :param external_application_id: The ID of the External Application. - :type external_application_id: str - - :returns: The External Application. - :rtype: ExternalApplication - - - - .. py:method:: delete() - - Deletes an External Application. - - :param external_application_id: The ID of the External Application. - :type external_application_id: str - - - -.. py:class:: ExternalInvite(client, userAlreadyInOrg=None, userAlreadyInAppGroup=None, userExistsAsInternal=None, successfulInvites=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The response of the invites for different emails - - :param client: An authenticated API Client instance - :type client: ApiClient - :param userAlreadyInOrg: List of user emails not successfullt invited, because they are already in the organization. - :type userAlreadyInOrg: list - :param userAlreadyInAppGroup: List of user emails not successfully invited, because they are already in the application group. - :type userAlreadyInAppGroup: list - :param userExistsAsInternal: List of user emails not successfully invited, because they are already internal users. - :type userExistsAsInternal: list - :param successfulInvites: List of users successfully invited. - :type successfulInvites: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ExtractedFields(client, data=None, rawLlmResponse=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The fields extracted from a document. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param data: The data for the document. - :type data: dict - :param rawLlmResponse: The raw llm response. Only returned if it could not be parsed to json. - :type rawLlmResponse: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Feature(client, name=None, selectClause=None, featureMapping=None, sourceTable=None, originalName=None, usingClause=None, orderClause=None, whereClause=None, featureType=None, dataType=None, detectedFeatureType=None, detectedDataType=None, columns={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature in a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column - :type name: str - :param selectClause: The sql logic for creating this feature's data - :type selectClause: str - :param featureMapping: The Feature Mapping of the feature - :type featureMapping: str - :param sourceTable: The source table of the column - :type sourceTable: str - :param originalName: The original name of the column - :type originalName: str - :param usingClause: Nested Column Using Clause - :type usingClause: str - :param orderClause: Nested Column Ordering Clause - :type orderClause: str - :param whereClause: Nested Column Where Clause - :type whereClause: str - :param featureType: Feature Type of the Feature - :type featureType: str - :param dataType: Data Type of the Feature - :type dataType: str - :param detectedFeatureType: The detected feature type of the column - :type detectedFeatureType: str - :param detectedDataType: The detected data type of the column - :type detectedDataType: str - :param columns: Nested Features - :type columns: NestedFeature - :param pointInTimeInfo: Point in time column information - :type pointInTimeInfo: PointInTimeFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureDistribution(client, type=None, trainingDistribution=None, predictionDistribution=None, numericalTrainingDistribution=None, numericalPredictionDistribution=None, trainingStatistics=None, predictionStatistics=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - For a single feature, how it has changed in the training data versus some specified window - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: Data type of values in each distribution, typically 'categorical' or 'numerical'. - :type type: str - :param trainingDistribution: A dict describing the range of values in the training distribution. - :type trainingDistribution: dict - :param predictionDistribution: A dict describing the range of values in the specified window. - :type predictionDistribution: dict - :param numericalTrainingDistribution: A dict describing the summary statistics of the numerical training distribution. - :type numericalTrainingDistribution: dict - :param numericalPredictionDistribution: A dict describing the summary statistics of the numerical prediction distribution. - :type numericalPredictionDistribution: dict - :param trainingStatistics: A dict describing summary statistics of values in the training distribution. - :type trainingStatistics: dict - :param predictionStatistics: A dict describing summary statistics of values in the specified window. - :type predictionStatistics: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: Unique identifier for this feature group. - :type featureGroupId: str - :param modificationLock: If feature group is locked against a change or not. - :type modificationLock: bool - :param name: - :type name: str - :param featureGroupSourceType: The source type of the feature group - :type featureGroupSourceType: str - :param tableName: Unique table name of this feature group. - :type tableName: str - :param sql: SQL definition creating this feature group. - :type sql: str - :param datasetId: Dataset ID the feature group is sourced from. - :type datasetId: str - :param functionSourceCode: Source definition creating this feature group. - :type functionSourceCode: str - :param functionName: Function name to execute from the source code. - :type functionName: str - :param sourceTables: Source tables for this feature group. - :type sourceTables: list[str] - :param createdAt: Timestamp at which the feature group was created. - :type createdAt: str - :param description: Description of the feature group. - :type description: str - :param sqlError: Error message with this feature group. - :type sqlError: str - :param latestVersionOutdated: Is latest materialized feature group version outdated. - :type latestVersionOutdated: bool - :param referencedFeatureGroups: Feature groups this feature group is used in. - :type referencedFeatureGroups: list[str] - :param tags: Tags added to this feature group. - :type tags: list[str] - :param primaryKey: Primary index feature. - :type primaryKey: str - :param updateTimestampKey: Primary timestamp feature. - :type updateTimestampKey: str - :param lookupKeys: Additional indexed features for this feature group. - :type lookupKeys: list[str] - :param streamingEnabled: If true, the feature group can have data streamed to it. - :type streamingEnabled: bool - :param incremental: If feature group corresponds to an incremental dataset. - :type incremental: bool - :param mergeConfig: Merge configuration settings for the feature group. - :type mergeConfig: dict - :param operatorConfig: Operator configuration settings for the feature group. - :type operatorConfig: dict - :param samplingConfig: Sampling configuration for the feature group. - :type samplingConfig: dict - :param cpuSize: CPU size specified for the Python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the Python feature group. - :type memory: int - :param streamingReady: If true, the feature group is ready to receive streaming data. - :type streamingReady: bool - :param featureTags: Tags for features in this feature group - :type featureTags: dict - :param moduleName: Path to the file with the feature group function. - :type moduleName: str - :param templateBindings: Config specifying variable names and values to use when resolving a feature group template. - :type templateBindings: dict - :param featureExpression: If the dataset feature group has custom features, the SQL select expression creating those features. - :type featureExpression: str - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: dict - :param pythonFunctionName: Name of the Python function the feature group was built from. - :type pythonFunctionName: str - :param useGpu: Whether this feature group is using gpu - :type useGpu: bool - :param features: List of resolved features. - :type features: Feature - :param duplicateFeatures: List of duplicate features. - :type duplicateFeatures: Feature - :param pointInTimeGroups: List of Point In Time Groups. - :type pointInTimeGroups: PointInTimeGroup - :param annotationConfig: Annotation config for this feature - :type annotationConfig: AnnotationConfig - :param latestFeatureGroupVersion: Latest feature group version. - :type latestFeatureGroupVersion: FeatureGroupVersion - :param concatenationConfig: Feature group ID whose data will be concatenated into this feature group. - :type concatenationConfig: ConcatenationConfig - :param indexingConfig: Indexing config for the feature group for feature store - :type indexingConfig: IndexingConfig - :param codeSource: If a Python feature group, information on the source code. - :type codeSource: CodeSource - :param featureGroupTemplate: FeatureGroupTemplate to use when this feature group is attached to a template. - :type featureGroupTemplate: FeatureGroupTemplate - :param explanation: Natural language explanation of the feature group - :type explanation: NaturalLanguageExplanation - :param refreshSchedules: List of schedules that determines when the next version of the feature group will be created. - :type refreshSchedules: RefreshSchedule - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: add_to_project(project_id, feature_group_type = 'CUSTOM_TABLE') - - Adds a feature group to a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - :param feature_group_type: The feature group type of the feature group, based on the use case under which the feature group is being created. - :type feature_group_type: str - - - - .. py:method:: set_project_config(project_id, project_config = None) - - Sets a feature group's project config - - :param project_id: Unique string identifier for the project. - :type project_id: str - :param project_config: Feature group's project configuration. - :type project_config: ProjectFeatureGroupConfig - - - - .. py:method:: get_project_config(project_id) - - Gets a feature group's project config - - :param project_id: Unique string identifier for the project. - :type project_id: str - - :returns: The feature group's project configuration. - :rtype: ProjectConfig - - - - .. py:method:: remove_from_project(project_id) - - Removes a feature group from a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - - - .. py:method:: set_type(project_id, feature_group_type = 'CUSTOM_TABLE') - - Update the feature group type in a project. The feature group must already be added to the project. - - :param project_id: Unique identifier associated with the project. - :type project_id: str - :param feature_group_type: The feature group type to set the feature group as. - :type feature_group_type: str - - - - .. py:method:: describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) - - Get the latest annotation entry for a given feature group, feature, and document. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - - :returns: The latest annotation entry for the given feature group, feature, document, and/or annotation key value. - :rtype: AnnotationEntry - - - - .. py:method:: verify_and_describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) - - Get the latest annotation entry for a given feature group, feature, and document along with verification information. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - - :returns: The latest annotation entry for the given feature group, feature, document, and/or annotation key value. Includes the verification information. - :rtype: AnnotationEntry - - - - .. py:method:: update_annotation_status(feature_name, status, doc_id = None, feature_group_row_identifier = None, save_metadata = False) - - Update the status of an annotation entry. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param status: The new status of the annotation. Must be one of the following: 'TODO', 'IN_PROGRESS', 'DONE'. - :type status: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - :param save_metadata: If True, save the metadata for the annotation entry. - :type save_metadata: bool - - :returns: The updated annotation entry. - :rtype: AnnotationEntry - - - - .. py:method:: get_document_to_annotate(project_id, feature_name, feature_group_row_identifier = None, get_previous = False) - - Get an available document that needs to be annotated for a annotation feature group. - - :param project_id: The ID of the project that the annotation is associated with. - :type project_id: str - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the primary key value. If provided, fetch the immediate next (or previous) available document. - :type feature_group_row_identifier: str - :param get_previous: If True, get the previous document instead of the next document. Applicable if feature_group_row_identifier is provided. - :type get_previous: bool - - :returns: The document to annotate. - :rtype: AnnotationDocument - - - - .. py:method:: get_annotations_status(feature_name = None, check_for_materialization = False) - - Get the status of the annotations for a given feature group and feature. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param check_for_materialization: If True, check if the feature group needs to be materialized before using for annotations. - :type check_for_materialization: bool - - :returns: The status of the annotations for the given feature group and feature. - :rtype: AnnotationsStatus - - - - .. py:method:: import_annotation_labels(file, annotation_type) - - Imports annotation labels from csv file. All valid values in the file will be imported as labels (including header row if present). - - :param file: The file to import. Must be a csv file. - :type file: io.TextIOBase - :param annotation_type: The type of the annotation. - :type annotation_type: str - - :returns: The annotation config for the feature group. - :rtype: AnnotationConfig - - - - .. py:method:: create_sampling(table_name, sampling_config, description = None) - - Creates a new Feature Group defined as a sample of rows from another Feature Group. - - For efficiency, sampling is approximate unless otherwise specified. (e.g. the number of rows may vary slightly from what was requested). - - - :param table_name: The unique name to be given to this sampling Feature Group. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param sampling_config: Dictionary defining the sampling method and its parameters. - :type sampling_config: SamplingConfig - :param description: A human-readable description of this Feature Group. - :type description: str - - :returns: The created Feature Group. - :rtype: FeatureGroup - - - - .. py:method:: set_sampling_config(sampling_config) - - Set a FeatureGroup’s sampling to the config values provided, so that the rows the FeatureGroup returns will be a sample of those it would otherwise have returned. - - :param sampling_config: A JSON string object specifying the sampling method and parameters specific to that sampling method. An empty sampling_config indicates no sampling. - :type sampling_config: SamplingConfig - - :returns: The updated FeatureGroup. - :rtype: FeatureGroup - - - - .. py:method:: set_merge_config(merge_config) - - Set a MergeFeatureGroup’s merge config to the values provided, so that the feature group only returns a bounded range of an incremental dataset. - - :param merge_config: JSON object string specifying the merge rule. An empty merge_config will default to only including the latest dataset version. - :type merge_config: MergeConfig - - :returns: The updated FeatureGroup. - :rtype: FeatureGroup - - - - .. py:method:: set_operator_config(operator_config) - - Set a OperatorFeatureGroup’s operator config to the values provided. - - :param operator_config: A dictionary object specifying the pre-defined operations. - :type operator_config: dict - - - - .. py:method:: set_schema(schema) - - Creates a new schema and points the feature group to the new feature group schema ID. - - :param schema: JSON string containing an array of objects with 'name' and 'dataType' properties. - :type schema: list - - - - .. py:method:: get_schema(project_id = None) - - Returns a schema for a given FeatureGroup in a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - :returns: A list of objects for each column in the specified feature group. - :rtype: list[Feature] - - - - .. py:method:: create_feature(name, select_expression) - - Creates a new feature in a Feature Group from a SQL select statement. - - :param name: The name of the feature to add. - :type name: str - :param select_expression: SQL SELECT expression to create the feature. - :type select_expression: str - - :returns: A Feature Group object with the newly added feature. - :rtype: FeatureGroup - - - - .. py:method:: add_tag(tag) - - Adds a tag to the feature group - - :param tag: The tag to add to the feature group. - :type tag: str - - - - .. py:method:: remove_tag(tag) - - Removes a tag from the specified feature group. - - :param tag: The tag to remove from the feature group. - :type tag: str - - - - .. py:method:: add_annotatable_feature(name, annotation_type) - - Add an annotatable feature in a Feature Group - - :param name: The name of the feature to add. - :type name: str - :param annotation_type: The type of annotation to set. - :type annotation_type: str - - :returns: The feature group after the feature has been set - :rtype: FeatureGroup - - - - .. py:method:: set_feature_as_annotatable_feature(feature_name, annotation_type, feature_group_row_identifier_feature = None, doc_id_feature = None) - - Sets an existing feature as an annotatable feature (Feature that can be annotated). - - :param feature_name: The name of the feature to set as annotatable. - :type feature_name: str - :param annotation_type: The type of annotation label to add. - :type annotation_type: str - :param feature_group_row_identifier_feature: The key value of the feature group row the annotation is on (cast to string) and uniquely identifies the feature group row. At least one of the doc_id or key value must be provided so that the correct annotation can be identified. - :type feature_group_row_identifier_feature: str - :param doc_id_feature: The name of the document ID feature. - :type doc_id_feature: str - - :returns: A feature group object with the newly added annotatable feature. - :rtype: FeatureGroup - - - - .. py:method:: set_annotation_status_feature(feature_name) - - Sets a feature as the annotation status feature for a feature group. - - :param feature_name: The name of the feature to set as the annotation status feature. - :type feature_name: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: unset_feature_as_annotatable_feature(feature_name) - - Unsets a feature as annotatable - - :param feature_name: The name of the feature to unset. - :type feature_name: str - - :returns: The feature group after unsetting the feature - :rtype: FeatureGroup - - - - .. py:method:: add_annotation_label(label_name, annotation_type, label_definition = None) - - Adds an annotation label - - :param label_name: The name of the label. - :type label_name: str - :param annotation_type: The type of the annotation to set. - :type annotation_type: str - :param label_definition: the definition of the label. - :type label_definition: str - - :returns: The feature group after adding the annotation label - :rtype: FeatureGroup - - - - .. py:method:: remove_annotation_label(label_name) - - Removes an annotation label - - :param label_name: The name of the label to remove. - :type label_name: str - - :returns: The feature group after adding the annotation label - :rtype: FeatureGroup - - - - .. py:method:: add_feature_tag(feature, tag) - - Adds a tag on a feature - - :param feature: The feature to set the tag on. - :type feature: str - :param tag: The tag to set on the feature. - :type tag: str - - - - .. py:method:: remove_feature_tag(feature, tag) - - Removes a tag from a feature - - :param feature: The feature to remove the tag from. - :type feature: str - :param tag: The tag to remove. - :type tag: str - - - - .. py:method:: create_nested_feature(nested_feature_name, table_name, using_clause, where_clause = None, order_clause = None) - - Creates a new nested feature in a feature group from a SQL statement. - - :param nested_feature_name: The name of the feature. - :type nested_feature_name: str - :param table_name: The table name of the feature group to nest. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param using_clause: The SQL join column or logic to join the nested table with the parent. - :type using_clause: str - :param where_clause: A SQL WHERE statement to filter the nested rows. - :type where_clause: str - :param order_clause: A SQL clause to order the nested rows. - :type order_clause: str - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: update_nested_feature(nested_feature_name, table_name = None, using_clause = None, where_clause = None, order_clause = None, new_nested_feature_name = None) - - Updates a previously existing nested feature in a feature group. - - :param nested_feature_name: The name of the feature to be updated. - :type nested_feature_name: str - :param table_name: The name of the table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param using_clause: The SQL join column or logic to join the nested table with the parent. - :type using_clause: str - :param where_clause: An SQL WHERE statement to filter the nested rows. - :type where_clause: str - :param order_clause: An SQL clause to order the nested rows. - :type order_clause: str - :param new_nested_feature_name: New name for the nested feature. - :type new_nested_feature_name: str - - :returns: A feature group object with the updated nested feature. - :rtype: FeatureGroup - - - - .. py:method:: delete_nested_feature(nested_feature_name) - - Delete a nested feature. - - :param nested_feature_name: The name of the feature to be deleted. - :type nested_feature_name: str - - :returns: A feature group object without the specified nested feature. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_feature(feature_name, history_table_name, aggregation_keys, timestamp_key, historical_timestamp_key, expression, lookback_window_seconds = None, lookback_window_lag_seconds = 0, lookback_count = None, lookback_until_position = 0) - - Creates a new point in time feature in a feature group using another historical feature group, window spec, and aggregate expression. - - We use the aggregation keys and either the lookbackWindowSeconds or the lookbackCount values to perform the window aggregation for every row in the current feature group. - - If the window is specified in seconds, then all rows in the history table which match the aggregation keys and with historicalTimeFeature greater than or equal to lookbackStartCount and less than the value of the current rows timeFeature are considered. An optional lookbackWindowLagSeconds (+ve or -ve) can be used to offset the current value of the timeFeature. If this value is negative, we will look at the future rows in the history table, so care must be taken to ensure that these rows are available in the online context when we are performing a lookup on this feature group. If the window is specified in counts, then we order the historical table rows aligning by time and consider rows from the window where the rank order is greater than or equal to lookbackCount and includes the row just prior to the current one. The lag is specified in terms of positions using lookbackUntilPosition. - - - :param feature_name: The name of the feature to create. - :type feature_name: str - :param history_table_name: The table name of the history table. - :type history_table_name: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param timestamp_key: Name of feature which contains the timestamp value for the point in time feature. - :type timestamp_key: str - :param historical_timestamp_key: Name of feature which contains the historical timestamp. - :type historical_timestamp_key: str - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param lookback_window_seconds: If window is specified in terms of time, number of seconds in the past from the current time for start of the window. - :type lookback_window_seconds: float - :param lookback_window_lag_seconds: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the "future" rows in the history table. - :type lookback_window_lag_seconds: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookback_until_position: int - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_feature(feature_name, history_table_name = None, aggregation_keys = None, timestamp_key = None, historical_timestamp_key = None, expression = None, lookback_window_seconds = None, lookback_window_lag_seconds = None, lookback_count = None, lookback_until_position = None, new_feature_name = None) - - Updates an existing Point-in-Time (PiT) feature in a feature group. See `createPointInTimeFeature` for detailed semantics. - - :param feature_name: The name of the feature. - :type feature_name: str - :param history_table_name: The table name of the history table. If not specified, we use the current table to do a self join. - :type history_table_name: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param timestamp_key: Name of the feature which contains the timestamp value for the PiT feature. - :type timestamp_key: str - :param historical_timestamp_key: Name of the feature which contains the historical timestamp. - :type historical_timestamp_key: str - :param expression: SQL Aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param lookback_window_seconds: If the window is specified in terms of time, the number of seconds in the past from the current time for the start of the window. - :type lookback_window_seconds: float - :param lookback_window_lag_seconds: Optional lag to offset the closest point for the window. If it is positive, we delay the start of the window. If it is negative, we are looking at the "future" rows in the history table. - :type lookback_window_lag_seconds: float - :param lookback_count: If the window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, we delay the start of the window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookback_until_position: int - :param new_feature_name: New name for the PiT feature. - :type new_feature_name: str - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_group(group_name, window_key, aggregation_keys, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = 0, lookback_count = None, lookback_until_position = 0) - - Create a Point-in-Time Group - - :param group_name: The name of the point in time group. - :type group_name: str - :param window_key: Name of feature to use for ordering the rows on the source table. - :type window_key: str - :param aggregation_keys: List of keys to perform on the source table for the window aggregation. - :type aggregation_keys: list - :param history_table_name: The table to use for aggregating, if not provided, the source table will be used. - :type history_table_name: str - :param history_window_key: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used. - :type history_window_key: str - :param history_aggregation_keys: List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys. - :type history_aggregation_keys: list - :param lookback_window: Number of seconds in the past from the current time for the start of the window. If 0, the lookback will include all rows. - :type lookback_window: float - :param lookback_window_lag: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, "future" rows in the history table are used. - :type lookback_window_lag: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, those many "future" rows in the history table are used. - :type lookback_until_position: int - - :returns: The feature group after the point in time group has been created. - :rtype: FeatureGroup - - - - .. py:method:: generate_point_in_time_features(group_name, columns, window_functions, prefix = None) - - Generates and adds PIT features given the selected columns to aggregate over, and the operations to include. - - :param group_name: Name of the point-in-time group. - :type group_name: str - :param columns: List of columns to generate point-in-time features for. - :type columns: list - :param window_functions: List of window functions to operate on. - :type window_functions: list - :param prefix: Prefix for generated features, defaults to group name - :type prefix: str - - :returns: Feature group object with newly added point-in-time features. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_group(group_name, window_key = None, aggregation_keys = None, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = None, lookback_count = None, lookback_until_position = None) - - Update Point-in-Time Group - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param window_key: Name of feature which contains the timestamp value for the point-in-time feature. - :type window_key: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param history_table_name: The table to use for aggregating, if not provided, the source table will be used. - :type history_table_name: str - :param history_window_key: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used. - :type history_window_key: str - :param history_aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys. - :type history_aggregation_keys: list - :param lookback_window: Number of seconds in the past from the current time for the start of the window. - :type lookback_window: float - :param lookback_window_lag: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, future rows in the history table are looked at. - :type lookback_window_lag: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, those many future rows in the history table are looked at. - :type lookback_until_position: int - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: delete_point_in_time_group(group_name) - - Delete point in time group - - :param group_name: The name of the point in time group. - :type group_name: str - - :returns: The feature group after the point in time group has been deleted. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_group_feature(group_name, name, expression) - - Create point in time group feature - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param name: The name of the feature to add to the point-in-time group. - :type name: str - :param expression: A SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_group_feature(group_name, name, expression) - - Update a feature's SQL expression in a point in time group - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param name: The name of the feature to add to the point-in-time group. - :type name: str - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: set_feature_type(feature, feature_type, project_id = None) - - Set the type of a feature in a feature group. Specify the feature group ID, feature name, and feature type, and the method will return the new column with the changes reflected. - - :param feature: The name of the feature. - :type feature: str - :param feature_type: The machine learning type of the data in the feature. - :type feature_type: str - :param project_id: Optional unique ID associated with the project. - :type project_id: str - - :returns: The feature group after the data_type is applied. - :rtype: Schema - - - - .. py:method:: invalidate_streaming_data(invalid_before_timestamp) - - Invalidates all streaming data with timestamp before invalidBeforeTimestamp - - :param invalid_before_timestamp: Unix timestamp; any data with a timestamp before this time will be invalidated - :type invalid_before_timestamp: int - - - - .. py:method:: concatenate_data(source_feature_group_id, merge_type = 'UNION', replace_until_timestamp = None, skip_materialize = False) - - Concatenates data from one Feature Group to another. Feature Groups can be merged if their schemas are compatible, they have the special `updateTimestampKey` column, and (if set) the `primaryKey` column. The second operand in the concatenate operation will be appended to the first operand (merge target). - - :param source_feature_group_id: The Feature Group to concatenate with the destination Feature Group. - :type source_feature_group_id: str - :param merge_type: `UNION` or `INTERSECTION`. - :type merge_type: str - :param replace_until_timestamp: The UNIX timestamp to specify the point until which we will replace data from the source Feature Group. - :type replace_until_timestamp: int - :param skip_materialize: If `True`, will not materialize the concatenated Feature Group. - :type skip_materialize: bool - - - - .. py:method:: remove_concatenation_config() - - Removes the concatenation config on a destination feature group. - - :param feature_group_id: Unique identifier of the destination feature group to remove the concatenation configuration from. - :type feature_group_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroup - - - - .. py:method:: describe() - - Describe a Feature Group. - - :param feature_group_id: A unique string identifier associated with the feature group. - :type feature_group_id: str - - :returns: The feature group object. - :rtype: FeatureGroup - - - - .. py:method:: set_indexing_config(primary_key = None, update_timestamp_key = None, lookup_keys = None) - - Sets various attributes of the feature group used for primary key, deployment lookups and streaming updates. - - :param primary_key: Name of the feature which defines the primary key of the feature group. - :type primary_key: str - :param update_timestamp_key: Name of the feature which defines the update timestamp of the feature group. Used in concatenation and primary key deduplication. - :type update_timestamp_key: str - :param lookup_keys: List of feature names which can be used in the lookup API to restrict the computation to a set of dataset rows. These feature names have to correspond to underlying dataset columns. - :type lookup_keys: list - - - - .. py:method:: update(description = None) - - Modify an existing Feature Group. - - :param description: Description of the Feature Group. - :type description: str - - :returns: Updated Feature Group object. - :rtype: FeatureGroup - - - - .. py:method:: detach_from_template() - - Update a feature group to detach it from a template. - - :param feature_group_id: Unique string identifier associated with the feature group. - :type feature_group_id: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_template_bindings(template_bindings = None) - - Update the feature group template bindings for a template feature group. - - :param template_bindings: Values in these bindings override values set in the template. - :type template_bindings: list - - :returns: Updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_python_function_bindings(python_function_bindings) - - Updates an existing Feature Group's Python function bindings from a user-provided Python Function. If a list of feature groups are supplied within the Python function bindings, we will provide DataFrames (Pandas in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. - - :param python_function_bindings: List of python function arguments. - :type python_function_bindings: List - - - - .. py:method:: update_python_function(python_function_name, python_function_bindings = None, cpu_size = None, memory = None, use_gpu = None, use_original_csv_names = None) - - Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function - - bindings, we will provide as arguments to the function DataFrame's (pandas in the case of Python) with the materialized - feature groups for those input feature groups. - - - :param python_function_name: The name of the python function to be associated with the feature group. - :type python_function_name: str - :param python_function_bindings: List of python function arguments. - :type python_function_bindings: List - :param cpu_size: Size of the CPU for the feature group python function. - :type cpu_size: str - :param memory: Memory (in GB) for the feature group python function. - :type memory: int - :param use_gpu: Whether the feature group needs a gpu or not. Otherwise default to CPU. - :type use_gpu: bool - :param use_original_csv_names: If enabled, it uses the original column names for input feature groups from CSV datasets. - :type use_original_csv_names: bool - - - - .. py:method:: update_sql_definition(sql) - - Updates the SQL statement for a feature group. - - :param sql: The input SQL statement for the feature group. - :type sql: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_dataset_feature_expression(feature_expression) - - Updates the SQL feature expression for a Dataset FeatureGroup's custom features - - :param feature_expression: The input SQL statement for the feature group. - :type feature_expression: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_feature(name, select_expression = None, new_name = None) - - Modifies an existing feature in a feature group. - - :param name: Name of the feature to be updated. - :type name: str - :param select_expression: SQL statement for modifying the feature. - :type select_expression: str - :param new_name: New name of the feature. - :type new_name: str - - :returns: Updated feature group object. - :rtype: FeatureGroup - - - - .. py:method:: list_exports() - - Lists all of the feature group exports for the feature group - - :param feature_group_id: Unique identifier of the feature group - :type feature_group_id: str - - :returns: List of feature group exports - :rtype: list[FeatureGroupExport] - - - - .. py:method:: set_modifier_lock(locked = True) - - Lock a feature group to prevent modification. - - :param locked: Whether to disable or enable feature group modification (True or False). - :type locked: bool - - - - .. py:method:: list_modifiers() - - List the users who can modify a given feature group. - - :param feature_group_id: Unique string identifier of the feature group. - :type feature_group_id: str - - :returns: Information about the modification lock status and groups/organizations added to the feature group. - :rtype: ModificationLockInfo - - - - .. py:method:: add_user_to_modifiers(email) - - Adds a user to a feature group. - - :param email: The email address of the user to be added. - :type email: str - - - - .. py:method:: add_organization_group_to_modifiers(organization_group_id) - - Add OrganizationGroup to a feature group modifiers list - - :param organization_group_id: Unique string identifier of the organization group. - :type organization_group_id: str - - - - .. py:method:: remove_user_from_modifiers(email) - - Removes a user from a specified feature group. - - :param email: The email address of the user to be removed. - :type email: str - - - - .. py:method:: remove_organization_group_from_modifiers(organization_group_id) - - Removes an OrganizationGroup from a feature group modifiers list - - :param organization_group_id: The unique ID associated with the organization group. - :type organization_group_id: str - - - - .. py:method:: delete_feature(name) - - Removes a feature from the feature group. - - :param name: Name of the feature to be deleted. - :type name: str - - :returns: Updated feature group object. - :rtype: FeatureGroup - - - - .. py:method:: delete() - - Deletes a Feature Group. - - :param feature_group_id: Unique string identifier for the feature group to be removed. - :type feature_group_id: str - - - - .. py:method:: create_version(variable_bindings = None) - - Creates a snapshot for a specified feature group. Triggers materialization of the feature group. The new version of the feature group is created after it has materialized. - - :param variable_bindings: Dictionary defining variable bindings that override parent feature group values. - :type variable_bindings: dict - - :returns: A feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of all feature group versions for the specified feature group. - - :param limit: The maximum length of the returned versions. - :type limit: int - :param start_after_version: Results will start after this version. - :type start_after_version: str - - :returns: A list of feature group versions. - :rtype: list[FeatureGroupVersion] - - - - .. py:method:: create_template(name, template_sql, template_variables, description = None, template_bindings = None, should_attach_feature_group_to_template = False) - - Create a feature group template. - - :param name: User-friendly name for this feature group template. - :type name: str - :param template_sql: The template SQL that will be resolved by applying values from the template variables to generate SQL for a feature group. - :type template_sql: str - :param template_variables: The template variables for resolving the template. - :type template_variables: list - :param description: Description of this feature group template. - :type description: str - :param template_bindings: If the feature group will be attached to the newly created template, set these variable bindings on that feature group. - :type template_bindings: list - :param should_attach_feature_group_to_template: Set to `True` to convert the feature group to a template feature group and attach it to the newly created template. - :type should_attach_feature_group_to_template: bool - - :returns: The created feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: suggest_template_for() - - Suggest values for a feature gruop template, based on a feature group. - - :param feature_group_id: Unique identifier associated with the feature group to use for suggesting values to use in the template. - :type feature_group_id: str - - :returns: The suggested feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: get_recent_streamed_data() - - Returns recently streamed data to a streaming feature group. - - :param feature_group_id: Unique string identifier associated with the feature group. - :type feature_group_id: str - - - - .. py:method:: append_data(streaming_token, data) - - Appends new data into the feature group for a given lookup key recordId. - - :param streaming_token: The streaming token for authenticating requests. - :type streaming_token: str - :param data: The data to record as a JSON object. - :type data: dict - - - - .. py:method:: append_multiple_data(streaming_token, data) - - Appends new data into the feature group for a given lookup key recordId. - - :param streaming_token: Streaming token for authenticating requests. - :type streaming_token: str - :param data: Data to record, as a list of JSON objects. - :type data: list - - - - .. py:method:: upsert_data(data, streaming_token = None) - - Update new data into the feature group for a given lookup key record ID if the record ID is found; otherwise, insert new data into the feature group. - - :param data: The data to record, in JSON format. - :type data: dict - :param streaming_token: Optional streaming token for authenticating requests if upserting to streaming FG. - :type streaming_token: str - - :returns: The feature group row that was upserted. - :rtype: FeatureGroupRow - - - - .. py:method:: delete_data(primary_key) - - Deletes a row from the feature group given the primary key - - :param primary_key: The primary key value for which to delete the feature group row - :type primary_key: str - - - - .. py:method:: get_data(primary_key = None, num_rows = None) - - Gets the feature group rows for online updatable feature groups. - - If primary key is set, row corresponding to primary_key is returned. - If num_rows is set, we return maximum of num_rows latest updated rows. - - - :param primary_key: The primary key value for which to find the feature group row - :type primary_key: str - :param num_rows: Maximum number of rows to return from the feature group - :type num_rows: int - - :returns: A list of feature group rows. - :rtype: list[FeatureGroupRow] - - - - .. py:method:: get_natural_language_explanation(feature_group_version = None, model_id = None) - - Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model - - :param feature_group_version: A unique string identifier associated with the Feature Group Version. - :type feature_group_version: str - :param model_id: A unique string identifier associated with the Model. - :type model_id: str - - :returns: The object containing natural language explanation(s) as field(s). - :rtype: NaturalLanguageExplanation - - - - .. py:method:: generate_natural_language_explanation(feature_group_version = None, model_id = None) - - Generates natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model - - :param feature_group_version: A unique string identifier associated with the Feature Group Version. - :type feature_group_version: str - :param model_id: A unique string identifier associated with the Model. - :type model_id: str - - :returns: The object containing natural language explanation(s) as field(s). - :rtype: NaturalLanguageExplanation - - - - .. py:method:: wait_for_dataset(timeout = 7200) - - A waiting call until the feature group's dataset, if any, is ready for use. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_upload(timeout = 7200) - - Waits for a feature group created from a dataframe to be ready for materialization and version creation. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout = 7200) - - A waiting call until feature group is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_streaming_ready(timeout = 600) - - Waits for the feature group indexing config to be applied for streaming - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 600 seconds. - :type timeout: int - - - - .. py:method:: get_status(streaming_status = False) - - Gets the status of the feature group. - - :returns: A string describing the status of a feature group (pending, complete, etc.). - :rtype: str - - - - .. py:method:: load_as_pandas() - - Loads the feature groups into a python pandas dataframe. - - :returns: A pandas dataframe with annotations and text_snippet columns. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - - .. py:method:: describe_dataset() - - Displays the dataset attached to a feature group. - - :returns: A dataset object with all the relevant information about the dataset. - :rtype: Dataset - - - - .. py:method:: materialize() - - Materializes the feature group's latest change at the api call time. It'll skip materialization if no change since the current latest version. - - :returns: A feature group object with the lastest changes materialized. - :rtype: FeatureGroup - - - -.. py:class:: FeatureGroupExport(client, featureGroupExportId=None, failedWrites=None, totalWrites=None, featureGroupVersion=None, connectorType=None, outputLocation=None, fileFormat=None, databaseConnectorId=None, objectName=None, writeMode=None, databaseFeatureMapping=None, idColumn=None, status=None, createdAt=None, exportCompletedAt=None, additionalIdColumns=None, error=None, databaseOutputError=None, projectConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature Group Export Job - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupExportId: Unique identifier for this export. - :type featureGroupExportId: str - :param failedWrites: Number of failed writes. - :type failedWrites: int - :param totalWrites: Total number of writes. - :type totalWrites: int - :param featureGroupVersion: Version of the feature group being exported. - :type featureGroupVersion: str - :param connectorType: The type of connector - :type connectorType: str - :param outputLocation: File Connector location the feature group is being written to. - :type outputLocation: str - :param fileFormat: File format being written to `output_location`. - :type fileFormat: str - :param databaseConnectorId: Database connector ID used. - :type databaseConnectorId: str - :param objectName: Database connector's object to write to. - :type objectName: str - :param writeMode: `UPSERT` or `INSERT` for writing to the database connector. - :type writeMode: str - :param databaseFeatureMapping: Column/feature pairs mapping the features to the database columns. - :type databaseFeatureMapping: dict - :param idColumn: ID column to use as the upsert key. - :type idColumn: str - :param status: Current status of the export. - :type status: str - :param createdAt: Timestamp at which the export was created (ISO-8601 format). - :type createdAt: str - :param exportCompletedAt: Timestamp at which the export completed (ISO-8601 format). - :type exportCompletedAt: str - :param additionalIdColumns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additionalIdColumns: list[str] - :param error: If `status` is `FAILED`, this field will be populated with an error. - :type error: str - :param databaseOutputError: If `True`, there were errors reported by the database connector while writing. - :type databaseOutputError: bool - :param projectConfig: Project config for this feature group. - :type projectConfig: ProjectConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get_feature_group_version_export_download_url() - - Get a link to download the feature group version. - - :param feature_group_export_id: Unique identifier of the Feature Group Export to get a signed URL for. - :type feature_group_export_id: str - - :returns: Instance containing the download URL and expiration time for the Feature Group Export. - :rtype: FeatureGroupExportDownloadUrl - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupExport - - - - .. py:method:: describe() - - A feature group export - - :param feature_group_export_id: Unique identifier of the feature group export. - :type feature_group_export_id: str - - :returns: The feature group export object. - :rtype: FeatureGroupExport - - - - .. py:method:: get_connector_errors() - - Returns a stream containing the write errors of the feature group export database connection, if any writes failed to the database connector. - - :param feature_group_export_id: Unique identifier of the feature group export to get the errors for. - :type feature_group_export_id: str - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until feature group export is created. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_export(timeout=3600) - - A waiting call until feature group export is created. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the feature group export. - - :returns: A string describing the status of a feature group export (pending, complete, etc.). - :rtype: str - - - -.. py:class:: FeatureGroupExportConfig(client, outputLocation=None, fileFormat=None, databaseConnectorId=None, objectName=None, writeMode=None, databaseFeatureMapping=None, idColumn=None, additionalIdColumns=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Export configuration (file connector or database connector information) for feature group exports. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param outputLocation: The File Connector location to which the feature group is being written. - :type outputLocation: str - :param fileFormat: The file format being written to output_location. - :type fileFormat: str - :param databaseConnectorId: The unique string identifier of the database connector used. - :type databaseConnectorId: str - :param objectName: The object in the database connector to which the feature group is being written. - :type objectName: str - :param writeMode: UPSERT or INSERT for writing to the database connector. - :type writeMode: str - :param databaseFeatureMapping: The column/feature pairs mapping the features to the database columns. - :type databaseFeatureMapping: dict - :param idColumn: The id column to use as the upsert key. - :type idColumn: str - :param additionalIdColumns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additionalIdColumns: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroupExportDownloadUrl(client, downloadUrl=None, expiresAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Feature Group Export Download Url, which is used to download the feature group version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param downloadUrl: The URL of the download location. - :type downloadUrl: str - :param expiresAt: String representation of the ISO-8601 datetime when the URL expires. - :type expiresAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroupRow(client, featureGroupId=None, primaryKey=None, createdAt=None, updatedAt=None, contents=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A row of a feature group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The ID of the feature group this row belongs to. - :type featureGroupId: str - :param primaryKey: Value of the primary key for this row. - :type primaryKey: str - :param createdAt: The timestamp this feature group row was created in ISO-8601 format. - :type createdAt: str - :param updatedAt: The timestamp when this feature group row was last updated in ISO-8601 format. - :type updatedAt: str - :param contents: A dictionary of feature names and values for this row. - :type contents: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroupRowProcess(client, featureGroupId=None, deploymentId=None, primaryKeyValue=None, featureGroupRowProcessId=None, createdAt=None, updatedAt=None, startedAt=None, completedAt=None, timeoutAt=None, retriesRemaining=None, totalAttemptsAllowed=None, status=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature group row process - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The ID of the feature group this row that was processed belongs to. - :type featureGroupId: str - :param deploymentId: The ID of the deployment that processed this row. - :type deploymentId: str - :param primaryKeyValue: Value of the primary key for this row. - :type primaryKeyValue: str - :param featureGroupRowProcessId: The ID of the feature group row process. - :type featureGroupRowProcessId: str - :param createdAt: The timestamp this feature group row was created in ISO-8601 format. - :type createdAt: str - :param updatedAt: The timestamp when this feature group row was last updated in ISO-8601 format. - :type updatedAt: str - :param startedAt: The timestamp when this feature group row process was started in ISO-8601 format. - :type startedAt: str - :param completedAt: The timestamp when this feature group row was completed. - :type completedAt: str - :param timeoutAt: The time the feature group row process will timeout. - :type timeoutAt: str - :param retriesRemaining: The number of retries remaining for this feature group row process. - :type retriesRemaining: int - :param totalAttemptsAllowed: The total number of attempts allowed for this feature group row process. - :type totalAttemptsAllowed: int - :param status: The status of the feature group row process. - :type status: str - :param error: The error message if the status is FAILED. - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: wait_for_process(timeout=1200) - - A waiting call until model monitor version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the feature group row process. - - :returns: A string describing the status of the feature group row process - :rtype: str - - - -.. py:class:: FeatureGroupRowProcessLogs(client, logs=None, featureGroupId=None, deploymentId=None, primaryKeyValue=None, featureGroupRowProcessId=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs for the feature group row process. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param logs: The logs for both stdout and stderr of the step - :type logs: str - :param featureGroupId: The ID of the feature group this row that was processed belongs to. - :type featureGroupId: str - :param deploymentId: The ID of the deployment that processed this row. - :type deploymentId: str - :param primaryKeyValue: Value of the primary key for this row. - :type primaryKeyValue: str - :param featureGroupRowProcessId: The ID of the feature group row process. - :type featureGroupRowProcessId: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroupRowProcessSummary(client, totalProcesses=None, pendingProcesses=None, processingProcesses=None, completeProcesses=None, failedProcesses=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A summary of the feature group processes for a deployment. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param totalProcesses: The total number of processes - :type totalProcesses: int - :param pendingProcesses: The number of pending processes - :type pendingProcesses: int - :param processingProcesses: The number of processes currently processing - :type processingProcesses: int - :param completeProcesses: The number of complete processes - :type completeProcesses: int - :param failedProcesses: The number of failed processes - :type failedProcesses: int - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroupTemplate(client, featureGroupTemplateId=None, description=None, featureGroupId=None, isSystemTemplate=None, name=None, templateSql=None, templateVariables=None, createdAt=None, updatedAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A template for creating feature groups. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupTemplateId: The unique identifier for this feature group template. - :type featureGroupTemplateId: str - :param description: A user-friendly text description of this feature group template. - :type description: str - :param featureGroupId: The unique identifier for the feature group used to create this template. - :type featureGroupId: str - :param isSystemTemplate: True if this is a system template returned from a user organization. - :type isSystemTemplate: bool - :param name: The user-friendly name of this feature group template. - :type name: str - :param templateSql: SQL that can include variables which will be replaced by values from the template config to resolve this template SQL into a valid SQL query for a feature group. - :type templateSql: str - :param templateVariables: A map, from template variable names to parameters for replacing those template variables with values (e.g. to values and metadata on how to resolve those values). - :type templateVariables: dict - :param createdAt: When the feature group template was created. - :type createdAt: str - :param updatedAt: When the feature group template was updated. - :type updatedAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete an existing feature group template. - - :param feature_group_template_id: Unique string identifier associated with the feature group template. - :type feature_group_template_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupTemplate - - - - .. py:method:: describe() - - Describe a Feature Group Template. - - :param feature_group_template_id: The unique identifier of a feature group template. - :type feature_group_template_id: str - - :returns: The feature group template object. - :rtype: FeatureGroupTemplate - - - - .. py:method:: update(template_sql = None, template_variables = None, description = None, name = None) - - Update a feature group template. - - :param template_sql: If provided, the new value to use for the template SQL. - :type template_sql: str - :param template_variables: If provided, the new value to use for the template variables. - :type template_variables: list - :param description: Description of this feature group template. - :type description: str - :param name: User-friendly name for this feature group template. - :type name: str - - :returns: The updated feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: preview_resolution(template_bindings = None, template_sql = None, template_variables = None, should_validate = True) - - Resolve template sql using template variables and template bindings. - - :param template_bindings: Values to override the template variable values specified by the template. - :type template_bindings: list - :param template_sql: If specified, use this as the template SQL instead of the feature group template's SQL. - :type template_sql: str - :param template_variables: Template variables to use. If a template is provided, this overrides the template's template variables. - :type template_variables: list - :param should_validate: If true, validates the resolved SQL. - :type should_validate: bool - - :returns: The resolved template - :rtype: ResolvedFeatureGroupTemplate - - - -.. py:class:: FeatureGroupVersion(client, featureGroupVersion=None, featureGroupId=None, sql=None, sourceTables=None, sourceDatasetVersions=None, createdAt=None, status=None, error=None, deployable=None, cpuSize=None, memory=None, useOriginalCsvNames=None, pythonFunctionBindings=None, indexingConfigWarningMsg=None, materializationStartedAt=None, materializationCompletedAt=None, columns=None, templateBindings=None, features={}, pointInTimeGroups={}, codeSource={}, annotationConfig={}, indexingConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A materialized version of a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupVersion: The unique identifier for this materialized version of feature group. - :type featureGroupVersion: str - :param featureGroupId: The unique identifier of the feature group this version belongs to. - :type featureGroupId: str - :param sql: The sql definition creating this feature group. - :type sql: str - :param sourceTables: The source tables for this feature group. - :type sourceTables: list[str] - :param sourceDatasetVersions: The dataset version ids for this feature group version. - :type sourceDatasetVersions: list[str] - :param createdAt: The timestamp at which the feature group version was created. - :type createdAt: str - :param status: The current status of the feature group version. - :type status: str - :param error: Relevant error if the status is FAILED. - :type error: str - :param deployable: whether feature group is deployable or not. - :type deployable: bool - :param cpuSize: Cpu size specified for the python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the python feature group. - :type memory: int - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: list - :param indexingConfigWarningMsg: The warning message related to indexing keys. - :type indexingConfigWarningMsg: str - :param materializationStartedAt: The timestamp at which the feature group materialization started. - :type materializationStartedAt: str - :param materializationCompletedAt: The timestamp at which the feature group materialization completed. - :type materializationCompletedAt: str - :param columns: List of resolved columns. - :type columns: list[feature] - :param templateBindings: Template variable bindings used for resolving the template. - :type templateBindings: list - :param features: List of features. - :type features: Feature - :param pointInTimeGroups: List of Point In Time Groups - :type pointInTimeGroups: PointInTimeGroup - :param codeSource: If a python feature group, information on the source code - :type codeSource: CodeSource - :param annotationConfig: The annotations config for the feature group. - :type annotationConfig: AnnotationConfig - :param indexingConfig: The indexing config for the feature group. - :type indexingConfig: IndexingConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: create_snapshot_feature_group(table_name) - - Creates a Snapshot Feature Group corresponding to a specific Feature Group version. - - :param table_name: Name for the newly created Snapshot Feature Group table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - - :returns: Feature Group corresponding to the newly created Snapshot. - :rtype: FeatureGroup - - - - .. py:method:: export_to_file_connector(location, export_file_format, overwrite = False) - - Export Feature group to File Connector. - - :param location: Cloud file location to export to. - :type location: str - :param export_file_format: Enum string specifying the file format to export to. - :type export_file_format: str - :param overwrite: If true and a file exists at this location, this process will overwrite the file. - :type overwrite: bool - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_database_connector(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) - - Export Feature group to Database Connector. - - :param database_connector_id: Unique string identifier for the Database Connector to export to. - :type database_connector_id: str - :param object_name: Name of the database object to write to. - :type object_name: str - :param write_mode: Enum string indicating whether to use INSERT or UPSERT. - :type write_mode: str - :param database_feature_mapping: Key/value pair JSON object of "database connector column" -> "feature name" pairs. - :type database_feature_mapping: dict - :param id_column: Required if write_mode is UPSERT. Indicates which database column should be used as the lookup key. - :type id_column: str - :param additional_id_columns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additional_id_columns: list - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_console(export_file_format) - - Export Feature group to console. - - :param export_file_format: File format to export to. - :type export_file_format: str - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: get_materialization_logs(stdout = False, stderr = False) - - Returns logs for a materialized feature group version. - - :param stdout: Set to True to get info logs. - :type stdout: bool - :param stderr: Set to True to get error logs. - :type stderr: bool - - :returns: A function logs object. - :rtype: FunctionLogs - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupVersion - - - - .. py:method:: describe() - - Describe a feature group version. - - :param feature_group_version: The unique identifier associated with the feature group version. - :type feature_group_version: str - - :returns: The feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) - - Get metrics for a specific feature group version. - - :param selected_columns: A list of columns to order first. - :type selected_columns: List - :param include_charts: A flag indicating whether charts should be included in the response. Default is false. - :type include_charts: bool - :param include_statistics: A flag indicating whether statistics should be included in the response. Default is true. - :type include_statistics: bool - - :returns: The metrics for the specified feature group version. - :rtype: DataMetrics - - - - .. py:method:: get_logs() - - Retrieves the feature group materialization logs. - - :param feature_group_version: The unique version ID of the feature group version. - :type feature_group_version: str - - :returns: The logs for the specified feature group version. - :rtype: FeatureGroupVersionLogs - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until feature group version is materialized - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout=3600) - - A waiting call until feature group version is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the feature group version. - - :returns: A string describing the status of a feature group version (pending, complete, etc.). - :rtype: str - - - - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) - - - .. py:method:: load_as_pandas(max_workers=10) - - Loads the feature group version into a pandas dataframe. - - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe displaying the data in the feature group version. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column, max_workers=10) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - -.. py:class:: FeatureGroupVersionLogs(client, logs=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs from feature group version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param logs: List of logs from feature group version. - :type logs: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureImportance(client, shapFeatureImportance=None, limeFeatureImportance=None, permutationFeatureImportance=None, nullFeatureImportance=None, lofoFeatureImportance=None, ebmFeatureImportance=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Feature importance for a specified model monitor - - :param client: An authenticated API Client instance - :type client: ApiClient - :param shapFeatureImportance: A map of feature name to feature importance, determined by Shap values on a sample dataset. - :type shapFeatureImportance: dict - :param limeFeatureImportance: A map of feature name to feature importance, determined by Lime contribution values on a sample dataset. - :type limeFeatureImportance: dict - :param permutationFeatureImportance: A map of feature name to feature importance, determined by permutation importance. - :type permutationFeatureImportance: dict - :param nullFeatureImportance: A map of feature name to feature importance, determined by null feature importance. - :type nullFeatureImportance: dict - :param lofoFeatureImportance: A map of feature name to feature importance, determined by the Leave One Feature Out method. - :type lofoFeatureImportance: dict - :param ebmFeatureImportance: A map of feature name to feature importance, determined by an Explainable Boosting Machine. - :type ebmFeatureImportance: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FileConnector(client, bucket=None, verified=None, writePermission=None, authExpiresAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Verification result for an external storage service - - :param client: An authenticated API Client instance - :type client: ApiClient - :param bucket: The address of the bucket. eg., `s3://your-bucket` - :type bucket: str - :param verified: `true` if the bucket has passed verification - :type verified: bool - :param writePermission: `true` if Abacus.AI has permission to write to this bucket - :type writePermission: bool - :param authExpiresAt: The time when the file connector's auth expires, if applicable - :type authExpiresAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FileConnectorInstructions(client, verified=None, writePermission=None, authOptions=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An object with a full description of the cloud storage bucket authentication options and bucket policy. Returns an error message if the parameters are invalid. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param verified: `True` if the bucket has passed verification - :type verified: bool - :param writePermission: `True` if Abacus.AI has permission to write to this bucket - :type writePermission: bool - :param authOptions: A list of options for giving Abacus.AI access to this bucket - :type authOptions: list[dict] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FileConnectorVerification(client, verified=None, writePermission=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - To verify the file connector - - :param client: An authenticated API Client instance - :type client: ApiClient - :param verified: `true` if the bucket has passed verification - :type verified: bool - :param writePermission: `true` if Abacus.AI has permission to write to this bucket - :type writePermission: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FunctionLogs(client, function=None, stats=None, stdout=None, stderr=None, algorithm=None, exception={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs from an invocation of a function. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param function: The function this is logging - :type function: str - :param stats: Statistics for the start and end time execution for this function - :type stats: dict - :param stdout: Standard out logs - :type stdout: str - :param stderr: Standard error logs - :type stderr: str - :param algorithm: Algorithm name for this function - :type algorithm: str - :param exception: The exception stacktrace - :type exception: UserException - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: GeneratedPitFeatureConfigOption(client, name=None, displayName=None, default=None, description=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The options to display for possible generated PIT aggregation functions - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The short name of the aggregation type. - :type name: str - :param displayName: The display name of the aggregation type. - :type displayName: str - :param default: The default value for the option. - :type default: bool - :param description: The description of the aggregation type. - :type description: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: GraphDashboard(client, name=None, graphDashboardId=None, createdAt=None, projectId=None, pythonFunctionIds=None, plotReferenceIds=None, pythonFunctionNames=None, projectName=None, description=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Graph Dashboard - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The user-friendly name for the graph dashboard. - :type name: str - :param graphDashboardId: The unique identifier of the graph dashboard. - :type graphDashboardId: str - :param createdAt: Date and time at which the graph dashboard was created, in ISO-8601 format. - :type createdAt: str - :param projectId: The unique identifier of the project this graph dashboard belongs to. - :type projectId: str - :param pythonFunctionIds: List of Python function IDs included in the dashboard. - :type pythonFunctionIds: list[str] - :param plotReferenceIds: List of the graph reference IDs for the plots to the dashboard. - :type plotReferenceIds: list[str] - :param pythonFunctionNames: List of names of each of the plots to the dashboard. - :type pythonFunctionNames: list[str] - :param projectName: The name the graph dashboard belongs to. - :type projectName: str - :param description: The description of the graph dashboard. - :type description: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: GraphDashboard - - - - .. py:method:: describe() - - Describes a given graph dashboard. - - :param graph_dashboard_id: Unique identifier for the graph dashboard. - :type graph_dashboard_id: str - - :returns: An object containing information about the graph dashboard. - :rtype: GraphDashboard - - - - .. py:method:: delete() - - Deletes a graph dashboard - - :param graph_dashboard_id: Unique string identifier for the graph dashboard to be deleted. - :type graph_dashboard_id: str - - - - .. py:method:: update(name = None, python_function_ids = None) - - Updates a graph dashboard - - :param name: Name of the dashboard. - :type name: str - :param python_function_ids: List of unique string identifiers for the Python functions to be used in the graph dashboard. - :type python_function_ids: List - - :returns: An object describing the graph dashboard. - :rtype: GraphDashboard - - - -.. py:class:: HoldoutAnalysis(client, holdoutAnalysisId=None, name=None, featureGroupIds=None, modelId=None, modelName=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A holdout analysis object. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param holdoutAnalysisId: The unique identifier of the holdout analysis. - :type holdoutAnalysisId: str - :param name: The name of the holdout analysis. - :type name: str - :param featureGroupIds: The feature group ids associated with the holdout analysis. - :type featureGroupIds: list[str] - :param modelId: The model id associated with the holdout analysis. - :type modelId: str - :param modelName: The model name associated with the holdout analysis. - :type modelName: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: rerun(model_version = None, algorithm = None) - - Rerun a holdout analysis. A different model version and algorithm can be specified which should be under the same model. - - :param model_version: (optional) Version of the model to use for the holdout analysis - :type model_version: str - :param algorithm: (optional) ID of algorithm to use for the holdout analysis - :type algorithm: str - - :returns: The created holdout analysis version - :rtype: HoldoutAnalysisVersion - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: HoldoutAnalysis - - - - .. py:method:: describe() - - Get a holdout analysis. - - :param holdout_analysis_id: ID of the holdout analysis to get - :type holdout_analysis_id: str - - :returns: The holdout analysis - :rtype: HoldoutAnalysis - - - - .. py:method:: list_versions() - - List holdout analysis versions for a holdout analysis. - - :param holdout_analysis_id: ID of the holdout analysis to list holdout analysis versions for - :type holdout_analysis_id: str - - :returns: The holdout analysis versions - :rtype: list[HoldoutAnalysisVersion] - - - -.. py:class:: HoldoutAnalysisVersion(client, holdoutAnalysisVersion=None, holdoutAnalysisId=None, createdAt=None, status=None, error=None, modelId=None, modelVersion=None, algorithm=None, algoName=None, metrics=None, metricInfos=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A holdout analysis version object. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param holdoutAnalysisVersion: The unique identifier of the holdout analysis version. - :type holdoutAnalysisVersion: str - :param holdoutAnalysisId: The unique identifier of the holdout analysis. - :type holdoutAnalysisId: str - :param createdAt: The timestamp at which the holdout analysis version was created. - :type createdAt: str - :param status: The status of the holdout analysis version. - :type status: str - :param error: The error message if the status is FAILED. - :type error: str - :param modelId: The model id associated with the holdout analysis. - :type modelId: str - :param modelVersion: The model version associated with the holdout analysis. - :type modelVersion: str - :param algorithm: The algorithm used to train the model. - :type algorithm: str - :param algoName: The name of the algorithm used to train the model. - :type algoName: str - :param metrics: The metrics of the holdout analysis version. - :type metrics: dict - :param metricInfos: The metric infos of the holdout analysis version. - :type metricInfos: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: HoldoutAnalysisVersion - - - - .. py:method:: describe(get_metrics = False) - - Get a holdout analysis version. - - :param get_metrics: (optional) Whether to get the metrics for the holdout analysis version - :type get_metrics: bool - - :returns: The holdout analysis version - :rtype: HoldoutAnalysisVersion - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until holdout analysis for the version is complete - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the holdout analysis version. - - :returns: A string describing the status of a holdout analysis version (pending, complete, etc.). - :rtype: str - - - -.. py:class:: InferredFeatureMappings(client, error=None, featureMappings={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A description of the data use for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param error: Error message if there was an error inferring the feature mappings - :type error: str - :param featureMappings: The inferred feature mappings - :type featureMappings: FeatureMapping - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: LlmApp(client, llmAppId=None, name=None, description=None, projectId=None, deploymentId=None, createdAt=None, updatedAt=None, status=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An LLM App that can be used for generation. LLM Apps are specifically crafted to help with certain tasks like code generation or question answering. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param llmAppId: The unique identifier of the LLM App. - :type llmAppId: str - :param name: The name of the LLM App. - :type name: str - :param description: The description of the LLM App. - :type description: str - :param projectId: The project ID of the deployment associated with the LLM App. - :type projectId: str - :param deploymentId: The deployment ID associated with the LLM App. - :type deploymentId: str - :param createdAt: The timestamp at which the LLM App was created. - :type createdAt: str - :param updatedAt: The timestamp at which the LLM App was updated. - :type updatedAt: str - :param status: The status of the LLM App's deployment. - :type status: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: LlmExecutionResult(client, status=None, error=None, execution={}, preview={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Results of executing queries using LLM. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param status: The status of the execution. - :type status: str - :param error: The error message if the execution failed. - :type error: str - :param execution: Information on execution of the query. - :type execution: ExecuteFeatureGroupOperation - :param preview: Preview of executing queries using LLM. - :type preview: LlmExecutionPreview - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: LlmGeneratedCode(client, sql=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code generated by LLM. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sql: SQL query generated by LLM. - :type sql: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: LlmInput(client, content=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The result of encoding an object as input for a language model. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param content: Content of the response - :type content: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: LlmResponse(client, content=None, tokens=None, stopReason=None, llmName=None, codeBlocks={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The response returned by LLM - - :param client: An authenticated API Client instance - :type client: ApiClient - :param content: Full response from LLM. - :type content: str - :param tokens: The number of tokens in the response. - :type tokens: int - :param stopReason: The reason due to which the response generation stopped. - :type stopReason: str - :param llmName: The name of the LLM model used to generate the response. - :type llmName: str - :param codeBlocks: A list of parsed code blocks from raw LLM Response - :type codeBlocks: LlmCodeBlock - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Model(client, name=None, modelId=None, modelConfigType=None, modelPredictionConfig=None, createdAt=None, projectId=None, shared=None, sharedAt=None, trainFunctionName=None, predictFunctionName=None, predictManyFunctionName=None, initializeFunctionName=None, trainingInputTables=None, sourceCode=None, cpuSize=None, memory=None, trainingFeatureGroupIds=None, algorithmModelConfigs=None, trainingVectorStoreVersions=None, documentRetrievers=None, documentRetrieverIds=None, isPythonModel=None, defaultAlgorithm=None, customAlgorithmConfigs=None, restrictedAlgorithms=None, useGpu=None, notebookId=None, trainingRequired=None, dataLlmFeatureGroups=None, location={}, refreshSchedules={}, codeSource={}, databaseConnector={}, latestModelVersion={}, modelConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A model - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The user-friendly name for the model. - :type name: str - :param modelId: The unique identifier of the model. - :type modelId: str - :param modelConfigType: Name of the TrainingConfig class of the model_config. - :type modelConfigType: str - :param modelPredictionConfig: The prediction config options for the model. - :type modelPredictionConfig: dict - :param createdAt: Date and time at which the model was created. - :type createdAt: str - :param projectId: The project this model belongs to. - :type projectId: str - :param shared: If model is shared to the Abacus.AI model showcase. - :type shared: bool - :param sharedAt: The date and time at which the model was shared to the model showcase - :type sharedAt: str - :param trainFunctionName: Name of the function found in the source code that will be executed to train the model. It is not executed when this function is run. - :type trainFunctionName: str - :param predictFunctionName: Name of the function found in the source code that will be executed run predictions through model. It is not executed when this function is run. - :type predictFunctionName: str - :param predictManyFunctionName: Name of the function found in the source code that will be executed to run batch predictions trhough the model. - :type predictManyFunctionName: str - :param initializeFunctionName: Name of the function found in the source code to initialize the trained model before using it to make predictions using the model - :type initializeFunctionName: str - :param trainingInputTables: List of feature groups that are supplied to the train function as parameters. Each of the parameters are materialized Dataframes (same type as the functions return value). - :type trainingInputTables: list - :param sourceCode: Python code used to make the model. - :type sourceCode: str - :param cpuSize: Cpu size specified for the python model training. - :type cpuSize: str - :param memory: Memory in GB specified for the python model training. - :type memory: int - :param trainingFeatureGroupIds: The unique identifiers of the feature groups used as the inputs to train this model on. - :type trainingFeatureGroupIds: list of unique string identifiers - :param algorithmModelConfigs: List of algorithm specific training configs. - :type algorithmModelConfigs: list[dict] - :param trainingVectorStoreVersions: The vector store version IDs used as inputs during training to create this ModelVersion. - :type trainingVectorStoreVersions: list - :param documentRetrievers: List of document retrievers use to create this model. - :type documentRetrievers: list - :param documentRetrieverIds: List of document retriever IDs used to create this model. - :type documentRetrieverIds: list - :param isPythonModel: If this model is handled as python model - :type isPythonModel: bool - :param defaultAlgorithm: If set, this algorithm will always be used when deploying the model regardless of the model metrics - :type defaultAlgorithm: str - :param customAlgorithmConfigs: User-defined configs for each of the user-defined custom algorithm - :type customAlgorithmConfigs: dict - :param restrictedAlgorithms: User-selected algorithms to train. - :type restrictedAlgorithms: dict - :param useGpu: If this model uses gpu. - :type useGpu: bool - :param notebookId: The notebook associated with this model. - :type notebookId: str - :param trainingRequired: If training is required to keep the model up-to-date. - :type trainingRequired: bool - :param dataLlmFeatureGroups: List of feature groups used by the model for queries - :type dataLlmFeatureGroups: list[featuregroup] - :param latestModelVersion: The latest model version. - :type latestModelVersion: ModelVersion - :param location: Location information for models that are imported. - :type location: ModelLocation - :param refreshSchedules: List of refresh schedules that indicate when the next model version will be trained - :type refreshSchedules: RefreshSchedule - :param codeSource: If a python model, information on the source code - :type codeSource: CodeSource - :param databaseConnector: Database connector used by the model. - :type databaseConnector: DatabaseConnector - :param modelConfig: The training config options used to train this model. - :type modelConfig: TrainingConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: describe_train_test_data_split_feature_group() - - Get the train and test data split for a trained model by its unique identifier. This is only supported for models with custom algorithms. - - :param model_id: The unique ID of the model. By default, the latest model version will be returned if no version is specified. - :type model_id: str - - :returns: The feature group containing the training data and fold information. - :rtype: FeatureGroup - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Model - - - - .. py:method:: describe() - - Retrieves a full description of the specified model. - - :param model_id: Unique string identifier associated with the model. - :type model_id: str - - :returns: Description of the model. - :rtype: Model - - - - .. py:method:: rename(name) - - Renames a model - - :param name: The new name to assign to the model. - :type name: str - - - - .. py:method:: update_python(function_source_code = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None, is_thread_safe = None, training_config = None) - - Updates an existing Python Model using user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the `train` and `predict` functions with the materialized feature groups for those input feature groups. - - This method expects `functionSourceCode` to be a valid language source file which contains the functions named `trainFunctionName` and `predictFunctionName`. `trainFunctionName` returns the ModelVersion that is the result of training the model using `trainFunctionName`. `predictFunctionName` has no well-defined return type, as it returns the prediction made by the `predictFunctionName`, which can be anything. - - - :param function_source_code: Contents of a valid Python source code file. The source code should contain the functions named `trainFunctionName` and `predictFunctionName`. A list of allowed import and system libraries for each language is specified in the user functions documentation section. - :type function_source_code: str - :param train_function_name: Name of the function found in the source code that will be executed to train the model. It is not executed when this function is run. - :type train_function_name: str - :param predict_function_name: Name of the function found in the source code that will be executed to run predictions through the model. It is not executed when this function is run. - :type predict_function_name: str - :param predict_many_function_name: Name of the function found in the source code that will be executed to run batch predictions through the model. It is not executed when this function is run. - :type predict_many_function_name: str - :param initialize_function_name: Name of the function found in the source code to initialize the trained model before using it to make predictions using the model. - :type initialize_function_name: str - :param training_input_tables: List of feature groups that are supplied to the `train` function as parameters. Each of the parameters are materialized DataFrames (same type as the functions return value). - :type training_input_tables: list - :param cpu_size: Size of the CPU for the model training function. - :type cpu_size: str - :param memory: Memory (in GB) for the model training function. - :type memory: int - :param package_requirements: List of package requirement strings. For example: `['numpy==1.2.3', 'pandas>=1.4.0']`. - :type package_requirements: list - :param use_gpu: Whether this model needs gpu - :type use_gpu: bool - :param is_thread_safe: Whether this model is thread safe - :type is_thread_safe: bool - :param training_config: The training config used to train this model. - :type training_config: TrainingConfig - - :returns: The updated model. - :rtype: Model - - - - .. py:method:: update_python_zip(train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) - - Updates an existing Python Model using a provided zip file. If a list of input feature groups are supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. - - This method expects `trainModuleName` and `predictModuleName` to be valid language source files which contain the functions named `trainFunctionName` and `predictFunctionName`, respectively. `trainFunctionName` returns the ModelVersion that is the result of training the model using `trainFunctionName`, and `predictFunctionName` has no well-defined return type, as it returns the prediction made by the `predictFunctionName`, which can be anything. - - - :param train_function_name: Name of the function found in the train module that will be executed to train the model. It is not executed when this function is run. - :type train_function_name: str - :param predict_function_name: Name of the function found in the predict module that will be executed to run predictions through the model. It is not executed when this function is run. - :type predict_function_name: str - :param predict_many_function_name: Name of the function found in the predict module that will be executed to run batch predictions through the model. It is not executed when this function is run. - :type predict_many_function_name: str - :param train_module_name: Full path of the module that contains the train function from the root of the zip. - :type train_module_name: str - :param predict_module_name: Full path of the module that contains the predict function from the root of the zip. - :type predict_module_name: str - :param training_input_tables: List of feature groups that are supplied to the train function as parameters. Each of the parameters are materialized Dataframes (same type as the function's return value). - :type training_input_tables: list - :param cpu_size: Size of the CPU for the model training function. - :type cpu_size: str - :param memory: Memory (in GB) for the model training function. - :type memory: int - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']. - :type package_requirements: list - :param use_gpu: Whether this model needs gpu - :type use_gpu: bool - - :returns: The updated model. - :rtype: Upload - - - - .. py:method:: update_python_git(application_connector_id = None, branch_name = None, python_root = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, use_gpu = None) - - Updates an existing Python model using an existing Git application connector. If a list of input feature groups are supplied, these will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. - - This method expects `trainModuleName` and `predictModuleName` to be valid language source files which contain the functions named `trainFunctionName` and `predictFunctionName`, respectively. `trainFunctionName` returns the `ModelVersion` that is the result of training the model using `trainFunctionName`, and `predictFunctionName` has no well-defined return type, as it returns the prediction made by the `predictFunctionName`, which can be anything. - - - :param application_connector_id: The unique ID associated with the Git application connector. - :type application_connector_id: str - :param branch_name: Name of the branch in the Git repository to be used for training. - :type branch_name: str - :param python_root: Path from the top level of the Git repository to the directory containing the Python source code. If not provided, the default is the root of the Git repository. - :type python_root: str - :param train_function_name: Name of the function found in train module that will be executed to train the model. It is not executed when this function is run. - :type train_function_name: str - :param predict_function_name: Name of the function found in the predict module that will be executed to run predictions through model. It is not executed when this function is run. - :type predict_function_name: str - :param predict_many_function_name: Name of the function found in the predict module that will be executed to run batch predictions through model. It is not executed when this function is run. - :type predict_many_function_name: str - :param train_module_name: Full path of the module that contains the train function from the root of the zip. - :type train_module_name: str - :param predict_module_name: Full path of the module that contains the predict function from the root of the zip. - :type predict_module_name: str - :param training_input_tables: List of feature groups that are supplied to the train function as parameters. Each of the parameters are materialized Dataframes (same type as the functions return value). - :type training_input_tables: list - :param cpu_size: Size of the CPU for the model training function. - :type cpu_size: str - :param memory: Memory (in GB) for the model training function. - :type memory: int - :param use_gpu: Whether this model needs gpu - :type use_gpu: bool - - :returns: The updated model. - :rtype: Model - - - - .. py:method:: set_training_config(training_config, feature_group_ids = None) - - Edits the default model training config - - :param training_config: The training config used to train this model. - :type training_config: TrainingConfig - :param feature_group_ids: The list of feature groups used as input to the model. - :type feature_group_ids: List - - :returns: The model object corresponding to the updated training config. - :rtype: Model - - - - .. py:method:: set_prediction_params(prediction_config) - - Sets the model prediction config for the model - - :param prediction_config: Prediction configuration for the model. - :type prediction_config: dict - - :returns: Model object after the prediction configuration is applied. - :rtype: Model - - - - .. py:method:: get_metrics(model_version = None, return_graphs = False, validation = False) - - Retrieves metrics for all the algorithms trained in this model version. - - If only the model's unique identifier (model_id) is specified, the latest trained version of the model (model_version) is used. - - - :param model_version: Version of the model. - :type model_version: str - :param return_graphs: If true, will return the information used for the graphs on the model metrics page such as PR Curve per label. - :type return_graphs: bool - :param validation: If true, will return the validation metrics instead of the test metrics. - :type validation: bool - - :returns: An object containing the model metrics and explanations for what each metric means. - :rtype: ModelMetrics - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of versions for a given model. - - :param limit: Maximum length of the list of all dataset versions. - :type limit: int - :param start_after_version: Unique string identifier of the version after which the list starts. - :type start_after_version: str - - :returns: An array of model versions. - :rtype: list[ModelVersion] - - - - .. py:method:: retrain(deployment_ids = None, feature_group_ids = None, custom_algorithms = None, builtin_algorithms = None, custom_algorithm_configs = None, cpu_size = None, memory = None, training_config = None, algorithm_training_configs = None) - - Retrains the specified model, with an option to choose the deployments to which the retraining will be deployed. - - :param deployment_ids: List of unique string identifiers of deployments to automatically deploy to. - :type deployment_ids: List - :param feature_group_ids: List of feature group IDs provided by the user to train the model on. - :type feature_group_ids: List - :param custom_algorithms: List of user-defined algorithms to train. If not set, will honor the runs from the last time and applicable new custom algorithms. - :type custom_algorithms: list - :param builtin_algorithms: List of algorithm names or algorithm IDs of Abacus.AI built-in algorithms to train. If not set, will honor the runs from the last time and applicable new built-in algorithms. - :type builtin_algorithms: list - :param custom_algorithm_configs: User-defined training configs for each custom algorithm. - :type custom_algorithm_configs: dict - :param cpu_size: Size of the CPU for the user-defined algorithms during training. - :type cpu_size: str - :param memory: Memory (in GB) for the user-defined algorithms during training. - :type memory: int - :param training_config: The training config used to train this model. - :type training_config: TrainingConfig - :param algorithm_training_configs: List of algorithm specifc training configs that will be part of the model training AutoML run. - :type algorithm_training_configs: list - - :returns: The model that is being retrained. - :rtype: Model - - - - .. py:method:: delete() - - Deletes the specified model and all its versions. Models which are currently used in deployments cannot be deleted. - - :param model_id: Unique string identifier of the model to delete. - :type model_id: str - - - - .. py:method:: set_default_algorithm(algorithm = None, data_cluster_type = None) - - Sets the model's algorithm to default for all new deployments - - :param algorithm: Algorithm to pin in the model. - :type algorithm: str - :param data_cluster_type: Data cluster type to set the lead model for. - :type data_cluster_type: str - - - - .. py:method:: list_artifacts_exports(limit = 25) - - List all the model artifacts exports. - - :param limit: Maximum length of the list of all exports. - :type limit: int - - :returns: List of model artifacts exports. - :rtype: list[ModelArtifactsExport] - - - - .. py:method:: get_training_types_for_deployment(model_version = None, algorithm = None) - - Returns types of models that can be deployed for a given model instance ID. - - :param model_version: The unique ID associated with the model version to deploy. - :type model_version: str - :param algorithm: The unique ID associated with the algorithm to deploy. - :type algorithm: str - - :returns: Model training types for deployment. - :rtype: ModelTrainingTypeForDeployment - - - - .. py:method:: update_agent(function_source_code = None, agent_function_name = None, memory = None, package_requirements = None, description = None, enable_binary_input = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = None) - - Updates an existing AI Agent. A new version of the agent will be created and published. - - :param memory: Memory (in GB) for the agent. - :type memory: int - :param description: A description of the agent, including its purpose and instructions. - :type description: str - :param workflow_graph: The workflow graph for the agent. - :type workflow_graph: WorkflowGraph - :param agent_interface: The interface that the agent will be deployed with. - :type agent_interface: AgentInterface - - :returns: The updated agent. - :rtype: Agent - - - - .. py:method:: wait_for_training(timeout=None) - - A waiting call until model is trained. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_evaluation(timeout=None) - - A waiting call until model is evaluated completely. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_publish(timeout=None) - - A waiting call until agent is published. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_full_automl(timeout=None) - - A waiting call until full AutoML cycle is completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status(get_automl_status = False) - - Gets the status of the model training. - - :returns: A string describing the status of a model training (pending, complete, etc.). - :rtype: str - - - - .. py:method:: create_refresh_policy(cron) - - To create a refresh policy for a model. - - :param cron: A cron style string to set the refresh time. - :type cron: str - - :returns: The refresh policy object. - :rtype: RefreshPolicy - - - - .. py:method:: list_refresh_policies() - - Gets the refresh policies in a list. - - :returns: A list of refresh policy objects. - :rtype: List[RefreshPolicy] - - - - .. py:method:: get_train_test_feature_group_as_pandas() - - Get the model train test data split feature group as pandas. - - :returns: A pandas dataframe for the training data with fold column. - :rtype: pandas.Dataframe - - - -.. py:class:: ModelArtifactsExport(client, modelArtifactsExportId=None, modelVersion=None, outputLocation=None, status=None, createdAt=None, exportCompletedAt=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Model Artifacts Export Job - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelArtifactsExportId: Unique identifier for this export. - :type modelArtifactsExportId: str - :param modelVersion: Version of the model being exported. - :type modelVersion: str - :param outputLocation: File Connector location the feature group is being written to. - :type outputLocation: str - :param status: Current status of the export. - :type status: str - :param createdAt: Timestamp at which the export was created (ISO-8601 format). - :type createdAt: str - :param exportCompletedAt: Timestamp at which the export completed (ISO-8601 format). - :type exportCompletedAt: str - :param error: If `status` is `FAILED`, this field will be populated with an error. - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ModelArtifactsExport - - - - .. py:method:: describe() - - Get the description and status of the model artifacts export. - - :param model_artifacts_export_id: A unique string identifier for the export. - :type model_artifacts_export_id: str - - :returns: Object describing the export and its status. - :rtype: ModelArtifactsExport - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until model artifacts export is created. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model artifacts export. - - :returns: A string describing the status of a model artifacts export (pending, complete, etc.). - :rtype: str - - - -.. py:class:: ModelMetrics(client, algoMetrics=None, selectedAlgorithm=None, selectedAlgorithmName=None, modelId=None, modelVersion=None, metricNames=None, targetColumn=None, trainValTestSplit=None, trainingCompletedAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Metrics of the trained model. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param algoMetrics: Dictionary mapping algorithm ID to algorithm name and algorithm metrics dictionary - :type algoMetrics: dict - :param selectedAlgorithm: The algorithm ID of the selected (default) algorithm that will be used in deployments of this Model Version - :type selectedAlgorithm: str - :param selectedAlgorithmName: The algorithm name of the selected (default) algorithm that will be used in deployments of this Model Version - :type selectedAlgorithmName: str - :param modelId: The Model ID - :type modelId: str - :param modelVersion: The Model Version - :type modelVersion: str - :param metricNames: Maps shorthand names of the metrics to their verbose names - :type metricNames: dict - :param targetColumn: The target feature that the model was trained to predict - :type targetColumn: str - :param trainValTestSplit: Info on train, val and test split - :type trainValTestSplit: dict - :param trainingCompletedAt: Timestamp when training was completed - :type trainingCompletedAt: datetime - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelMonitor(client, modelMonitorId=None, name=None, createdAt=None, projectId=None, trainingFeatureGroupId=None, predictionFeatureGroupId=None, predictionFeatureGroupVersion=None, trainingFeatureGroupVersion=None, alertConfig=None, biasMetricId=None, metricConfigs=None, featureGroupMonitorConfigs=None, metricTypes=None, modelId=None, starred=None, batchPredictionId=None, monitorType=None, edaConfigs=None, trainingForecastConfig=None, predictionForecastConfig=None, forecastFrequency=None, trainingFeatureGroupSampling=None, predictionFeatureGroupSampling=None, monitorDriftConfig=None, predictionDataUseMappings=None, trainingDataUseMappings=None, refreshSchedules={}, latestMonitorModelVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A model monitor - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelMonitorId: The unique identifier of the model monitor. - :type modelMonitorId: str - :param name: The user-friendly name for the model monitor. - :type name: str - :param createdAt: Date and time at which the model was created. - :type createdAt: str - :param projectId: The project this model belongs to. - :type projectId: str - :param trainingFeatureGroupId: Feature group IDs that this model monitor is monitoring. - :type trainingFeatureGroupId: list[str] - :param predictionFeatureGroupId: Feature group IDs that this model monitor is monitoring. - :type predictionFeatureGroupId: list[str] - :param predictionFeatureGroupVersion: Feature group versions that this model monitor is monitoring. - :type predictionFeatureGroupVersion: list[str] - :param trainingFeatureGroupVersion: Feature group versions that this model monitor is monitoring. - :type trainingFeatureGroupVersion: list[str] - :param alertConfig: Alerting configuration for this model monitor. - :type alertConfig: dict - :param biasMetricId: The bias metric ID - :type biasMetricId: str - :param metricConfigs: Configurations for model monitor - :type metricConfigs: dict - :param featureGroupMonitorConfigs: Configurations for feature group monitor - :type featureGroupMonitorConfigs: dict - :param metricTypes: List of metric types - :type metricTypes: dict - :param modelId: Model ID that this model monitor is monitoring. - :type modelId: str - :param starred: Whether this model monitor is starred. - :type starred: bool - :param batchPredictionId: The batch prediction ID this model monitor monitors - :type batchPredictionId: str - :param monitorType: The type of the monitor, one of MODEL_MONITOR, or FEATURE_GROUP_MONITOR - :type monitorType: str - :param edaConfigs: The configs for EDA - :type edaConfigs: dict - :param trainingForecastConfig: The tarining config for forecast monitors - :type trainingForecastConfig: dict - :param predictionForecastConfig: The prediction config for forecast monitors - :type predictionForecastConfig: dict - :param forecastFrequency: The frequency of the forecast - :type forecastFrequency: str - :param trainingFeatureGroupSampling: Whether or not we sample from training feature group - :type trainingFeatureGroupSampling: bool - :param predictionFeatureGroupSampling: Whether or not we sample from prediction feature group - :type predictionFeatureGroupSampling: bool - :param monitorDriftConfig: The monitor drift config for the monitor - :type monitorDriftConfig: dict - :param predictionDataUseMappings: The data_use mapping of the prediction features - :type predictionDataUseMappings: dict - :param trainingDataUseMappings: The data_use mapping of the training features - :type trainingDataUseMappings: dict - :param latestMonitorModelVersion: The latest model monitor version. - :type latestMonitorModelVersion: ModelMonitorVersion - :param refreshSchedules: List of refresh schedules that indicate when the next model version will be trained. - :type refreshSchedules: RefreshSchedule - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: rerun() - - Re-runs the specified model monitor. - - :param model_monitor_id: Unique string identifier of the model monitor to re-run. - :type model_monitor_id: str - - :returns: The model monitor that is being re-run. - :rtype: ModelMonitor - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ModelMonitor - - - - .. py:method:: describe() - - Retrieves a full description of the specified model monitor. - - :param model_monitor_id: Unique string identifier associated with the model monitor. - :type model_monitor_id: str - - :returns: Description of the model monitor. - :rtype: ModelMonitor - - - - .. py:method:: get_summary() - - Gets the summary of a model monitor across versions. - - :param model_monitor_id: A unique string identifier associated with the model monitor. - :type model_monitor_id: str - - :returns: An object describing integrity, bias violations, model accuracy and drift for the model monitor. - :rtype: ModelMonitorSummary - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of versions for a given model monitor. - - :param limit: The maximum length of the list of all model monitor versions. - :type limit: int - :param start_after_version: The ID of the version after which the list starts. - :type start_after_version: str - - :returns: A list of model monitor versions. - :rtype: list[ModelMonitorVersion] - - - - .. py:method:: rename(name) - - Renames a model monitor - - :param name: The new name to apply to the model monitor. - :type name: str - - - - .. py:method:: delete() - - Deletes the specified Model Monitor and all its versions. - - :param model_monitor_id: Unique identifier of the Model Monitor to delete. - :type model_monitor_id: str - - - - .. py:method:: list_monitor_alerts_for_monitor(realtime_monitor_id = None) - - Retrieves the list of monitor alerts for a specified monitor. One of the model_monitor_id or realtime_monitor_id is required but not both. - - :param realtime_monitor_id: The unique ID associated with the real-time monitor. - :type realtime_monitor_id: str - - :returns: A list of monitor alerts. - :rtype: list[MonitorAlert] - - - -.. py:class:: ModelMonitorOrgSummary(client, summary=None, featureDrift=None, labelDrift=None, dataIntegrity=None, performance=None, alerts=None, monitorData=None, totalStarredMonitors=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A summary of an organization's model monitors - - :param client: An authenticated API Client instance - :type client: ApiClient - :param summary: Count of monitors, count of versions, count of total rows of prediction data, count of failed versions. - :type summary: dict - :param featureDrift: Percentage of monitors with and without KL divergence > 2. - :type featureDrift: dict - :param labelDrift: Histogram of label drift across versions. - :type labelDrift: dict - :param dataIntegrity: Counts of violations. - :type dataIntegrity: dict - :param performance: Model accuracy information. - :type performance: dict - :param alerts: Count of alerts that are raised. - :type alerts: dict - :param monitorData: Information about monitors used in the summary for each time period. - :type monitorData: dict - :param totalStarredMonitors: Total number of starred monitors. - :type totalStarredMonitors: int - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelMonitorSummary(client, modelAccuracy=None, modelDrift=None, dataIntegrity=None, biasViolations=None, alerts=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A summary of model monitor - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelAccuracy: A list of model accuracy objects including accuracy and monitor version information. - :type modelAccuracy: list - :param modelDrift: A list of model drift objects including label and prediction drifts and monitor version information. - :type modelDrift: list - :param dataIntegrity: A list of data integrity objects including counts of violations and monitor version information. - :type dataIntegrity: list - :param biasViolations: A list of bias objects including bias counts and monitor version information. - :type biasViolations: list - :param alerts: A list of alerts by type for each model monitor instance - :type alerts: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelMonitorSummaryFromOrg(client, data=None, infos=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A summary of model monitor given an organization - - :param client: An authenticated API Client instance - :type client: ApiClient - :param data: A list of either model accuracy, drift, data integrity, or bias chart objects and their monitor version information. - :type data: list - :param infos: A dictionary of model monitor information. - :type infos: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelMonitorVersion(client, modelMonitorVersion=None, status=None, modelMonitorId=None, monitoringStartedAt=None, monitoringCompletedAt=None, trainingFeatureGroupVersion=None, predictionFeatureGroupVersion=None, error=None, pendingDeploymentIds=None, failedDeploymentIds=None, metricConfigs=None, featureGroupMonitorConfigs=None, metricTypes=None, modelVersion=None, batchPredictionVersion=None, edaConfigs=None, trainingForecastConfig=None, predictionForecastConfig=None, forecastFrequency=None, monitorDriftConfig=None, predictionDataUseMappings=None, trainingDataUseMappings=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a model monitor - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelMonitorVersion: The unique identifier of a model monitor version. - :type modelMonitorVersion: str - :param status: The current status of the model. - :type status: str - :param modelMonitorId: A reference to the model monitor this version belongs to. - :type modelMonitorId: str - :param monitoringStartedAt: The start time and date of the monitoring process. - :type monitoringStartedAt: str - :param monitoringCompletedAt: The end time and date of the monitoring process. - :type monitoringCompletedAt: str - :param trainingFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is monitoring. - :type trainingFeatureGroupVersion: list[str] - :param predictionFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is monitoring. - :type predictionFeatureGroupVersion: list[str] - :param error: Relevant error if the status is FAILED. - :type error: str - :param pendingDeploymentIds: List of deployment IDs where deployment is pending. - :type pendingDeploymentIds: list - :param failedDeploymentIds: List of failed deployment IDs. - :type failedDeploymentIds: list - :param metricConfigs: List of metric configs for the model monitor instance. - :type metricConfigs: list[dict] - :param featureGroupMonitorConfigs: Configurations for feature group monitor - :type featureGroupMonitorConfigs: dict - :param metricTypes: List of metric types. - :type metricTypes: list - :param modelVersion: Model version IDs that this refresh pipeline run is monitoring. - :type modelVersion: list[str] - :param batchPredictionVersion: The batch prediction version this model monitor is monitoring - :type batchPredictionVersion: str - :param edaConfigs: The list of eda configs for the version - :type edaConfigs: list - :param trainingForecastConfig: The training forecast config for the monitor version - :type trainingForecastConfig: dict - :param predictionForecastConfig: The prediction forecast config for the monitor version - :type predictionForecastConfig: dict - :param forecastFrequency: The forecast frequency for the monitor version - :type forecastFrequency: str - :param monitorDriftConfig: The monitor drift config for the monitor version - :type monitorDriftConfig: dict - :param predictionDataUseMappings: The mapping of prediction data use to feature group version - :type predictionDataUseMappings: dict - :param trainingDataUseMappings: The mapping of training data use to feature group version - :type trainingDataUseMappings: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get_prediction_drift() - - Gets the label and prediction drifts for a model monitor. - - :param model_monitor_version: Unique string identifier for a model monitor version created under the project. - :type model_monitor_version: str - - :returns: Object describing training and prediction output label and prediction distributions. - :rtype: DriftDistributions - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ModelMonitorVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified model monitor version. - - :param model_monitor_version: The unique version ID of the model monitor version. - :type model_monitor_version: str - - :returns: A model monitor version. - :rtype: ModelMonitorVersion - - - - .. py:method:: delete() - - Deletes the specified model monitor version. - - :param model_monitor_version: Unique identifier of the model monitor version to delete. - :type model_monitor_version: str - - - - .. py:method:: metric_data(metric_type, actual_values_to_detail = None) - - Provides the data needed for decile metrics associated with the model monitor. - - :param metric_type: The type of metric to get data for. - :type metric_type: str - :param actual_values_to_detail: The actual values to detail. - :type actual_values_to_detail: list - - :returns: Data associated with the metric. - :rtype: ModelMonitorVersionMetricData - - - - .. py:method:: list_monitor_alert_versions_for_monitor_version() - - Retrieves the list of monitor alert versions for a specified monitor instance. - - :param model_monitor_version: The unique ID associated with the model monitor. - :type model_monitor_version: str - - :returns: A list of monitor alert versions. - :rtype: list[MonitorAlertVersion] - - - - .. py:method:: get_drift_for_feature(feature_name, nested_feature_name = None) - - Gets the feature drift associated with a single feature in an output feature group from a prediction. - - :param feature_name: Name of the feature to view the distribution of. - :type feature_name: str - :param nested_feature_name: Optionally, the name of the nested feature that the feature is in. - :type nested_feature_name: str - - :returns: An object describing the training and prediction output feature distributions. - :rtype: FeatureDistribution - - - - .. py:method:: get_outliers_for_feature(feature_name = None, nested_feature_name = None) - - Gets a list of outliers measured by a single feature (or overall) in an output feature group from a prediction. - - :param feature_name: Name of the feature to view the distribution of. - :type feature_name: str - :param nested_feature_name: Optionally, the name of the nested feature that the feature is in. - :type nested_feature_name: str - - - - .. py:method:: wait_for_monitor(timeout=1200) - - A waiting call until model monitor version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model monitor version. - - :returns: A string describing the status of the model monitor version, for e.g., pending, complete, etc. - :rtype: str - - - -.. py:class:: ModelMonitorVersionMetricData(client, name=None, algoName=None, featureGroupVersion=None, modelMonitor=None, modelMonitorVersion=None, metricInfos=None, metricNames=None, metrics=None, metricCharts=None, otherMetrics=None, actualValuesSupportedForDrilldown=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Data for displaying model monitor version metric data - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the metric type - :type name: str - :param algoName: The name of the algo used for the prediction metric - :type algoName: str - :param featureGroupVersion: The prediction feature group used for analysis - :type featureGroupVersion: str - :param modelMonitor: The id of the model monitor - :type modelMonitor: str - :param modelMonitorVersion: The id of the model monitor version - :type modelMonitorVersion: str - :param metricInfos: Name and description for metrics - :type metricInfos: dict - :param metricNames: Internal name to external name mapping - :type metricNames: dict - :param metrics: Metric name to metric data - :type metrics: dict - :param metricCharts: List of different metric charts - :type metricCharts: list - :param otherMetrics: List of other metrics to optionally plot - :type otherMetrics: list - :param actualValuesSupportedForDrilldown: List of values support for drilldown - :type actualValuesSupportedForDrilldown: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelTrainingTypeForDeployment(client, label=None, value=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Model training types for deployment. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param label: Labels to show to users in deployment UI - :type label: str - :param value: Value to use on backend for deployment API call - :type value: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelUpload(client, modelId=None, modelVersion=None, status=None, createdAt=None, modelUploadId=None, embeddingsUploadId=None, artifactsUploadId=None, verificationsUploadId=None, defaultItemsUploadId=None, modelFileUploadId=None, modelStateUploadId=None, inputPreprocessorUploadId=None, requirementsUploadId=None, resourcesUploadId=None, multiCatalogEmbeddingsUploadId=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A model version that includes the upload identifiers for the various required files. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelId: A reference to the model this version belongs to. - :type modelId: str - :param modelVersion: A unique identifier for the model version. - :type modelVersion: str - :param status: The current status of the model. - :type status: str - :param createdAt: The timestamp at which the model version was created, in ISO-8601 format. - :type createdAt: str - :param modelUploadId: An upload identifier to be used when uploading the TensorFlow Saved Model. - :type modelUploadId: str - :param embeddingsUploadId: An upload identifier to be used when uploading the embeddings CSV. - :type embeddingsUploadId: str - :param artifactsUploadId: An upload identifier to be used when uploading the artifacts JSON file. - :type artifactsUploadId: str - :param verificationsUploadId: An upload identifier to be used when uploading the verifications JSON file. - :type verificationsUploadId: str - :param defaultItemsUploadId: An upload identifier to be used when uploading the default items JSON file. - :type defaultItemsUploadId: str - :param modelFileUploadId: An upload identifier to be used when uploading the model JSON file. - :type modelFileUploadId: str - :param modelStateUploadId: An upload identifier to be used when uploading the model state JSON file. - :type modelStateUploadId: str - :param inputPreprocessorUploadId: An upload identifier to be used when uploading the input preprocessor JSON file. - :type inputPreprocessorUploadId: str - :param requirementsUploadId: An upload identifier to be used when uploading the requirements JSON file. - :type requirementsUploadId: str - :param resourcesUploadId: An upload identifier to be used when uploading the resources JSON file. - :type resourcesUploadId: str - :param multiCatalogEmbeddingsUploadId: An upload identifier to be used when upload the multi-catalog embeddings CSV file. - :type multiCatalogEmbeddingsUploadId: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelVersion(client, modelVersion=None, modelConfigType=None, status=None, modelId=None, modelPredictionConfig=None, trainingStartedAt=None, trainingCompletedAt=None, featureGroupVersions=None, error=None, pendingDeploymentIds=None, failedDeploymentIds=None, cpuSize=None, memory=None, automlComplete=None, trainingFeatureGroupIds=None, trainingDocumentRetrieverVersions=None, documentRetrieverMappings=None, bestAlgorithm=None, defaultAlgorithm=None, featureAnalysisStatus=None, dataClusterInfo=None, customAlgorithmConfigs=None, trainedModelTypes=None, useGpu=None, partialComplete=None, modelFeatureGroupSchemaMappings=None, trainingConfigUpdated=None, codeSource={}, modelConfig={}, deployableAlgorithms={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a model - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelVersion: The unique identifier of a model version. - :type modelVersion: str - :param modelConfigType: Name of the TrainingConfig class of the model_config. - :type modelConfigType: str - :param status: The current status of the model. - :type status: str - :param modelId: A reference to the model this version belongs to. - :type modelId: str - :param modelPredictionConfig: The prediction config options for the model. - :type modelPredictionConfig: dict - :param trainingStartedAt: The start time and date of the training process in ISO-8601 format. - :type trainingStartedAt: str - :param trainingCompletedAt: The end time and date of the training process in ISO-8601 format. - :type trainingCompletedAt: str - :param featureGroupVersions: A list of Feature Group version IDs used for model training. - :type featureGroupVersions: list - :param error: Relevant error if the status is FAILED. - :type error: str - :param pendingDeploymentIds: List of deployment IDs where deployment is pending. - :type pendingDeploymentIds: list - :param failedDeploymentIds: List of failed deployment IDs. - :type failedDeploymentIds: list - :param cpuSize: CPU size specified for the python model training. - :type cpuSize: str - :param memory: Memory in GB specified for the python model training. - :type memory: int - :param automlComplete: If true, all algorithms have completed training. - :type automlComplete: bool - :param trainingFeatureGroupIds: The unique identifiers of the feature groups used as inputs during training to create this ModelVersion. - :type trainingFeatureGroupIds: list - :param trainingDocumentRetrieverVersions: The document retriever version IDs used as inputs during training to create this ModelVersion. - :type trainingDocumentRetrieverVersions: list - :param documentRetrieverMappings: mapping of document retriever version to their respective information. - :type documentRetrieverMappings: dict - :param bestAlgorithm: Best performing algorithm. - :type bestAlgorithm: dict - :param defaultAlgorithm: Default algorithm that the user has selected. - :type defaultAlgorithm: dict - :param featureAnalysisStatus: Lifecycle of the feature analysis stage. - :type featureAnalysisStatus: str - :param dataClusterInfo: Information about the models for different data clusters. - :type dataClusterInfo: dict - :param customAlgorithmConfigs: User-defined configs for each of the user-defined custom algorithms. - :type customAlgorithmConfigs: dict - :param trainedModelTypes: List of trained model types. - :type trainedModelTypes: list - :param useGpu: Whether this model version is using gpu - :type useGpu: bool - :param partialComplete: If true, all required algorithms have completed training. - :type partialComplete: bool - :param modelFeatureGroupSchemaMappings: mapping of feature group to schema version - :type modelFeatureGroupSchemaMappings: dict - :param trainingConfigUpdated: If the training config has been updated since the instance was created. - :type trainingConfigUpdated: bool - :param codeSource: If a python model, information on where the source code is located. - :type codeSource: CodeSource - :param modelConfig: The training config options used to train this model. - :type modelConfig: TrainingConfig - :param deployableAlgorithms: List of deployable algorithms. - :type deployableAlgorithms: DeployableAlgorithm - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: describe_train_test_data_split_feature_group_version() - - Get the train and test data split for a trained model by model version. This is only supported for models with custom algorithms. - - :param model_version: The unique version ID of the model version. - :type model_version: str - - :returns: The feature group version containing the training data and folds information. - :rtype: FeatureGroupVersion - - - - .. py:method:: set_model_objective(metric = None) - - Sets the best model for all model instances of the model based on the specified metric, and updates the training configuration to use the specified metric for any future model versions. - - If metric is set to None, then just use the default selection - - - :param metric: The metric to use to determine the best model. - :type metric: str - - - - .. py:method:: get_feature_group_schemas_for() - - Gets the schema (including feature mappings) for all feature groups used in the model version. - - :param model_version: Unique string identifier for the version of the model. - :type model_version: str - - :returns: List of schema for all feature groups used in the model version. - :rtype: list[ModelVersionFeatureGroupSchema] - - - - .. py:method:: delete() - - Deletes the specified model version. Model versions which are currently used in deployments cannot be deleted. - - :param model_version: The unique identifier of the model version to delete. - :type model_version: str - - - - .. py:method:: export_model_artifact_as_feature_group(table_name, artifact_type = None) - - Exports metric artifact data for a model as a feature group. - - :param table_name: Name of the feature group table to create. - :type table_name: str - :param artifact_type: eval artifact type to export. - :type artifact_type: EvalArtifactType - - :returns: The created feature group. - :rtype: FeatureGroup - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ModelVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified model version. - - :param model_version: Unique string identifier of the model version. - :type model_version: str - - :returns: A model version. - :rtype: ModelVersion - - - - .. py:method:: get_feature_importance_by() - - Gets the feature importance calculated by various methods for the model. - - :param model_version: Unique string identifier for the model version. - :type model_version: str - - :returns: Feature importances for the model. - :rtype: FeatureImportance - - - - .. py:method:: get_training_data_logs() - - Retrieves the data preparation logs during model training. - - :param model_version: The unique version ID of the model version. - :type model_version: str - - :returns: A list of logs. - :rtype: list[DataPrepLogs] - - - - .. py:method:: get_training_logs(stdout = False, stderr = False) - - Returns training logs for the model. - - :param stdout: Set True to get info logs. - :type stdout: bool - :param stderr: Set True to get error logs. - :type stderr: bool - - :returns: A function logs object. - :rtype: FunctionLogs - - - - .. py:method:: export_custom(output_location, algorithm = None) - - Bundle custom model artifacts to a zip file, and export to the specified location. - - :param output_location: Location to export the model artifacts results. For example, s3://a-bucket/ - :type output_location: str - :param algorithm: The algorithm to be exported. Optional if there's only one custom algorithm in the model version. - :type algorithm: str - - :returns: Object describing the export and its status. - :rtype: ModelArtifactsExport - - - - .. py:method:: wait_for_training(timeout=None) - - A waiting call until model gets trained. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_full_automl(timeout=None) - - A waiting call until full AutoML cycle is completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model version under training. - - :returns: A string describing the status of a model training (pending, complete, etc.). - :rtype: str - - - - .. py:method:: get_train_test_feature_group_as_pandas() - - Get the model train test data split feature group of the model version as pandas data frame. - - :returns: A pandas dataframe for the training data with fold column. - :rtype: pandas.Dataframe - - - -.. py:class:: ModelVersionFeatureGroupSchema(client, featureGroupId=None, featureGroupName=None, schema={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Schema for a feature group used in model version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The ID of the feature group. - :type featureGroupId: str - :param featureGroupName: The name of the feature group. - :type featureGroupName: str - :param schema: List of feature schemas of a feature group. - :type schema: Schema - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModificationLockInfo(client, modificationLock=None, userEmails=None, organizationGroups=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Information about a modification lock for a certain object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modificationLock: Whether or not the object has its modification lock activated. - :type modificationLock: bool - :param userEmails: The list of user emails allowed to modify the object if the object's modification lock is activated. - :type userEmails: list of strings - :param organizationGroups: The list organization groups allowed to modify the object if the object's modification lock is activated. - :type organizationGroups: list of unique string identifiers - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Module(client, name=None, createdAt=None, notebookId=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Customer created python module - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name to identify the algorithm. Only uppercase letters, numbers, and underscores are allowed. - :type name: str - :param createdAt: The date and time when the Python function was created, in ISO-8601 format. - :type createdAt: str - :param notebookId: The unique string identifier of the notebook used to create or edit the module. - :type notebookId: str - :param codeSource: Information about the source code of the Python function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: MonitorAlert(client, name=None, monitorAlertId=None, createdAt=None, projectId=None, modelMonitorId=None, realtimeMonitorId=None, conditionConfig=None, actionConfig=None, conditionDescription=None, actionDescription=None, alertType=None, deploymentId=None, latestMonitorAlertVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Monitor Alert - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The user-friendly name for the alert. - :type name: str - :param monitorAlertId: The unique identifier of the monitor alert. - :type monitorAlertId: str - :param createdAt: Date and time at which the monitor alert was created. - :type createdAt: str - :param projectId: The project this alert belongs to. - :type projectId: str - :param modelMonitorId: The monitor id that this alert is associated with - :type modelMonitorId: str - :param realtimeMonitorId: The realtime monitor id that this alert is associated with - :type realtimeMonitorId: str - :param conditionConfig: The condition configuration for this alert. - :type conditionConfig: dict - :param actionConfig: The action configuration for this alert. - :type actionConfig: dict - :param conditionDescription: User friendly description of the condition - :type conditionDescription: str - :param actionDescription: User friendly description of the action - :type actionDescription: str - :param alertType: The type of the alert - :type alertType: str - :param deploymentId: The deployment ID this alert is associated with - :type deploymentId: str - :param latestMonitorAlertVersion: The latest monitor alert version. - :type latestMonitorAlertVersion: MonitorAlertVersion - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: update(alert_name = None, condition_config = None, action_config = None) - - Update monitor alert - - :param alert_name: Name of the alert. - :type alert_name: str - :param condition_config: Condition to run the actions for the alert. - :type condition_config: AlertConditionConfig - :param action_config: Configuration for the action of the alert. - :type action_config: AlertActionConfig - - :returns: Object describing the monitor alert. - :rtype: MonitorAlert - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: MonitorAlert - - - - .. py:method:: describe() - - Describes a given monitor alert id - - :param monitor_alert_id: Unique identifier of the monitor alert. - :type monitor_alert_id: str - - :returns: Object containing information about the monitor alert. - :rtype: MonitorAlert - - - - .. py:method:: run() - - Reruns a given monitor alert from latest monitor instance - - :param monitor_alert_id: Unique identifier of a monitor alert. - :type monitor_alert_id: str - - :returns: Object describing the monitor alert. - :rtype: MonitorAlert - - - - .. py:method:: delete() - - Delets a monitor alert - - :param monitor_alert_id: The unique string identifier of the alert to delete. - :type monitor_alert_id: str - - - -.. py:class:: MonitorAlertVersion(client, name=None, monitorAlertVersion=None, monitorAlertId=None, status=None, createdAt=None, alertingStartedAt=None, alertingCompletedAt=None, error=None, modelMonitorVersion=None, conditionConfig=None, actionConfig=None, alertResult=None, actionStatus=None, actionError=None, actionStartedAt=None, actionCompletedAt=None, conditionDescription=None, actionDescription=None, alertType=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A monitor alert version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The user-friendly name for the monitor alert. - :type name: str - :param monitorAlertVersion: The identifier for the alert version. - :type monitorAlertVersion: str - :param monitorAlertId: The identifier for the alert. - :type monitorAlertId: str - :param status: The current status of the monitor alert. - :type status: str - :param createdAt: Date and time at which the monitor alert was created. - :type createdAt: str - :param alertingStartedAt: The start time and date of the monitor alerting process. - :type alertingStartedAt: str - :param alertingCompletedAt: The end time and date of the monitor alerting process. - :type alertingCompletedAt: str - :param error: Relevant error if the status is FAILED. - :type error: str - :param modelMonitorVersion: The model monitor version associated with the monitor alert version. - :type modelMonitorVersion: str - :param conditionConfig: The condition configuration for this alert. - :type conditionConfig: dict - :param actionConfig: The action configuration for this alert. - :type actionConfig: dict - :param alertResult: The current result of the alert - :type alertResult: str - :param actionStatus: The current status of the action as a result of the monitor alert. - :type actionStatus: str - :param actionError: Relevant error if the action status is FAILED. - :type actionError: str - :param actionStartedAt: The start time and date of the actionfor the alerting process. - :type actionStartedAt: str - :param actionCompletedAt: The end time and date of the actionfor the alerting process. - :type actionCompletedAt: str - :param conditionDescription: User friendly description of the condition - :type conditionDescription: str - :param actionDescription: User friendly description of the action - :type actionDescription: str - :param alertType: The type of the alert - :type alertType: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: MonitorAlertVersion - - - - .. py:method:: describe() - - Describes a given monitor alert version id - - :param monitor_alert_version: Unique string identifier for the monitor alert. - :type monitor_alert_version: str - - :returns: An object describing the monitor alert version. - :rtype: MonitorAlertVersion - - - - .. py:method:: wait_for_monitor_alert(timeout=1200) - - A waiting call until model monitor version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the monitor alert version. - - :returns: A string describing the status of a monitor alert version (pending, running, complete, etc.). - :rtype: str - - - -.. py:class:: NaturalLanguageExplanation(client, shortExplanation=None, longExplanation=None, isOutdated=None, htmlExplanation=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Natural language explanation of an artifact/object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param shortExplanation: succinct explanation of the artifact - :type shortExplanation: str - :param longExplanation: Longer and verbose explanation of the artifact - :type longExplanation: str - :param isOutdated: Flag indicating whether the explanation is outdated due to a change in the underlying artifact - :type isOutdated: bool - :param htmlExplanation: HTML formatted explanation of the artifact - :type htmlExplanation: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: OrganizationGroup(client, organizationGroupId=None, permissions=None, groupName=None, defaultGroup=None, admin=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Organization Group. Defines the permissions available to the users who are members of the group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param organizationGroupId: The unique identifier of the Organization Group. - :type organizationGroupId: str - :param permissions: The list of permissions (VIEW, MODIFY, ADMIN, BILLING, API_KEY, INVITE_USER) the group has. - :type permissions: list of enum string - :param groupName: The name of the Organization Group. - :type groupName: str - :param defaultGroup: If true, all new users will be added to this group automatically. - :type defaultGroup: bool - :param admin: If true, this group contains all permissions available to the organization and cannot be modified or deleted. - :type admin: bool - :param createdAt: When the Organization Group was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: OrganizationGroup - - - - .. py:method:: describe() - - Returns the specific organization group passed in by the user. - - :param organization_group_id: The unique identifier of the organization group to be described. - :type organization_group_id: str - - :returns: Information about a specific organization group. - :rtype: OrganizationGroup - - - - .. py:method:: add_permission(permission) - - Adds a permission to the specified Organization Group. - - :param permission: Permission to add to the Organization Group. - :type permission: str - - - - .. py:method:: remove_permission(permission) - - Removes a permission from the specified Organization Group. - - :param permission: The permission to remove from the Organization Group. - :type permission: str - - - - .. py:method:: delete() - - Deletes the specified Organization Group - - :param organization_group_id: Unique string identifier of the organization group. - :type organization_group_id: str - - - - .. py:method:: add_user_to(email) - - Adds a user to the specified Organization Group. - - :param email: Email of the user to be added to the group. - :type email: str - - - - .. py:method:: remove_user_from(email) - - Removes a user from an Organization Group. - - :param email: Email of the user to remove. - :type email: str - - - - .. py:method:: set_default() - - Sets the default Organization Group to which all new users joining an organization are automatically added. - - :param organization_group_id: Unique string identifier of the Organization Group. - :type organization_group_id: str - - - -.. py:class:: OrganizationSearchResult(client, score=None, featureGroupContext=None, featureGroup={}, featureGroupVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A search result object which contains the retrieved artifact and its relevance score - - :param client: An authenticated API Client instance - :type client: ApiClient - :param score: The relevance score of the search result. - :type score: float - :param featureGroupContext: The rendered context for the feature group that can be used in prompts - :type featureGroupContext: str - :param featureGroup: The feature group object retrieved through search. - :type featureGroup: FeatureGroup - :param featureGroupVersion: The feature group version object retrieved through search. - :type featureGroupVersion: FeatureGroupVersion - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: OrganizationSecret(client, secretKey=None, value=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Organization secret - - :param client: An authenticated API Client instance - :type client: ApiClient - :param secretKey: The key of the secret - :type secretKey: str - :param value: The value of the secret - :type value: str - :param createdAt: The date and time when the secret was created, in ISO-8601 format. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PageData(client, docId=None, page=None, height=None, width=None, pageCount=None, pageText=None, pageTokenStartOffset=None, tokenCount=None, tokens=None, extractedText=None, rotationAngle=None, pageMarkdown=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Data extracted from a docstore page. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param docId: Unique Docstore string identifier for the document. - :type docId: str - :param page: The page number. Starts from 0. - :type page: int - :param height: The height of the page in pixels. - :type height: int - :param width: The width of the page in pixels. - :type width: int - :param pageCount: The total number of pages in document. - :type pageCount: int - :param pageText: The text extracted from the page. - :type pageText: str - :param pageTokenStartOffset: The offset of the first token in the page. - :type pageTokenStartOffset: int - :param tokenCount: The number of tokens in the page. - :type tokenCount: int - :param tokens: The tokens in the page. - :type tokens: list - :param extractedText: The extracted text in the page obtained from OCR. - :type extractedText: str - :param rotationAngle: The detected rotation angle of the page in degrees. Positive values indicate clockwise and negative values indicate anti-clockwise rotation from the original orientation. - :type rotationAngle: float - :param pageMarkdown: The markdown text for the page. - :type pageMarkdown: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Pipeline(client, pipelineName=None, pipelineId=None, createdAt=None, notebookId=None, cron=None, nextRunTime=None, isProd=None, warning=None, createdBy=None, steps={}, pipelineReferences={}, latestPipelineVersion={}, codeSource={}, pipelineVariableMappings={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Pipeline For Steps. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineName: The name of the pipeline this step is a part of. - :type pipelineName: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param createdAt: The date and time which the pipeline was created. - :type createdAt: str - :param notebookId: The reference to the notebook this pipeline belongs to. - :type notebookId: str - :param cron: A cron-style string that describes when this refresh policy is to be executed in UTC - :type cron: str - :param nextRunTime: The next time this pipeline will be run. - :type nextRunTime: str - :param isProd: Whether this pipeline is a production pipeline. - :type isProd: bool - :param warning: Warning message for possible errors that might occur if the pipeline is run. - :type warning: str - :param createdBy: The email of the user who created the pipeline - :type createdBy: str - :param steps: A list of the pipeline steps attached to the pipeline. - :type steps: PipelineStep - :param pipelineReferences: A list of references from the pipeline to other objects - :type pipelineReferences: PipelineReference - :param latestPipelineVersion: The latest version of the pipeline. - :type latestPipelineVersion: PipelineVersion - :param codeSource: information on the source code - :type codeSource: CodeSource - :param pipelineVariableMappings: A description of the function variables into the pipeline. - :type pipelineVariableMappings: PythonFunctionArgument - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Pipeline - - - - .. py:method:: describe() - - Describes a given pipeline. - - :param pipeline_id: The ID of the pipeline to describe. - :type pipeline_id: str - - :returns: An object describing a Pipeline - :rtype: Pipeline - - - - .. py:method:: update(project_id = None, pipeline_variable_mappings = None, cron = None, is_prod = None) - - Updates a pipeline for executing multiple steps. - - :param project_id: A unique string identifier for the pipeline. - :type project_id: str - :param pipeline_variable_mappings: List of Python function arguments for the pipeline. - :type pipeline_variable_mappings: List - :param cron: A cron-like string specifying the frequency of the scheduled pipeline runs. - :type cron: str - :param is_prod: Whether the pipeline is a production pipeline or not. - :type is_prod: bool - - :returns: An object that describes a Pipeline. - :rtype: Pipeline - - - - .. py:method:: rename(pipeline_name) - - Renames a pipeline. - - :param pipeline_name: The new name of the pipeline. - :type pipeline_name: str - - :returns: An object that describes a Pipeline. - :rtype: Pipeline - - - - .. py:method:: delete() - - Deletes a pipeline. - - :param pipeline_id: The ID of the pipeline to delete. - :type pipeline_id: str - - - - .. py:method:: list_versions(limit = 200) - - Lists the pipeline versions for a specified pipeline - - :param limit: The maximum number of pipeline versions to return. - :type limit: int - - :returns: A list of pipeline versions. - :rtype: list[PipelineVersion] - - - - .. py:method:: run(pipeline_variable_mappings = None) - - Runs a specified pipeline with the arguments provided. - - :param pipeline_variable_mappings: List of Python function arguments for the pipeline. - :type pipeline_variable_mappings: List - - :returns: The object describing the pipeline - :rtype: PipelineVersion - - - - .. py:method:: create_step(step_name, function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) - - Creates a step in a given pipeline. - - :param step_name: The name of the step. - :type step_name: str - :param function_name: The name of the Python function. - :type function_name: str - :param source_code: Contents of a valid Python source code file. The source code should contain the transform feature group functions. A list of allowed imports and system libraries for each language is specified in the user functions documentation section. - :type source_code: str - :param step_input_mappings: List of Python function arguments. - :type step_input_mappings: List - :param output_variable_mappings: List of Python function outputs. - :type output_variable_mappings: List - :param step_dependencies: List of step names this step depends on. - :type step_dependencies: list - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']. - :type package_requirements: list - :param cpu_size: Size of the CPU for the step function. - :type cpu_size: str - :param memory: Memory (in GB) for the step function. - :type memory: int - :param timeout: Timeout for the step in minutes, default is 300 minutes. - :type timeout: int - - :returns: Object describing the pipeline. - :rtype: Pipeline - - - - .. py:method:: describe_step_by_name(step_name) - - Describes a pipeline step by the step name. - - :param step_name: The name of the step. - :type step_name: str - - :returns: An object describing the pipeline step. - :rtype: PipelineStep - - - - .. py:method:: unset_refresh_schedule() - - Deletes the refresh schedule for a given pipeline. - - :param pipeline_id: The id of the pipeline. - :type pipeline_id: str - - :returns: Object describing the pipeline. - :rtype: Pipeline - - - - .. py:method:: pause_refresh_schedule() - - Pauses the refresh schedule for a given pipeline. - - :param pipeline_id: The id of the pipeline. - :type pipeline_id: str - - :returns: Object describing the pipeline. - :rtype: Pipeline - - - - .. py:method:: resume_refresh_schedule() - - Resumes the refresh schedule for a given pipeline. - - :param pipeline_id: The id of the pipeline. - :type pipeline_id: str - - :returns: Object describing the pipeline. - :rtype: Pipeline - - - - .. py:method:: create_step_from_function(step_name, function, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None) - - Creates a step in the pipeline from a python function. - - :param step_name: The name of the step. - :type step_name: str - :param function: The python function. - :type function: callable - :param step_input_mappings: List of Python function arguments. - :type step_input_mappings: List[PythonFunctionArguments] - :param output_variable_mappings: List of Python function ouputs. - :type output_variable_mappings: List[OutputVariableMapping] - :param step_dependencies: List of step names this step depends on. - :type step_dependencies: List[str] - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']. - :type package_requirements: list - :param cpu_size: Size of the CPU for the step function. - :type cpu_size: str - :param memory: Memory (in GB) for the step function. - :type memory: int - - - - .. py:method:: wait_for_pipeline(timeout=1200) - - A waiting call until all the stages of the latest pipeline version is completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the pipeline version. - - :returns: A string describing the status of a pipeline version (pending, running, complete, etc.). - :rtype: str - - - -.. py:class:: PipelineStep(client, pipelineStepId=None, pipelineId=None, stepName=None, pipelineName=None, createdAt=None, updatedAt=None, pythonFunctionId=None, stepDependencies=None, cpuSize=None, memory=None, timeout=None, pythonFunction={}, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A step in a pipeline. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineStepId: The reference to this step. - :type pipelineStepId: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param stepName: The name of the step. - :type stepName: str - :param pipelineName: The name of the pipeline this step is a part of. - :type pipelineName: str - :param createdAt: The date and time which this step was created. - :type createdAt: str - :param updatedAt: The date and time when this step was last updated. - :type updatedAt: str - :param pythonFunctionId: The python function_id. - :type pythonFunctionId: str - :param stepDependencies: List of steps this step depends on. - :type stepDependencies: list[str] - :param cpuSize: CPU size specified for the step function. - :type cpuSize: str - :param memory: Memory in GB specified for the step function. - :type memory: int - :param timeout: Timeout for the step in minutes, default is 300 minutes. - :type timeout: int - :param pythonFunction: Information about the python function for the step. - :type pythonFunction: PythonFunction - :param codeSource: Information about the source code of the step function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Deletes a step from a pipeline. - - :param pipeline_step_id: The ID of the pipeline step. - :type pipeline_step_id: str - - - - .. py:method:: update(function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) - - Creates a step in a given pipeline. - - :param function_name: The name of the Python function. - :type function_name: str - :param source_code: Contents of a valid Python source code file. The source code should contain the transform feature group functions. A list of allowed imports and system libraries for each language is specified in the user functions documentation section. - :type source_code: str - :param step_input_mappings: List of Python function arguments. - :type step_input_mappings: List - :param output_variable_mappings: List of Python function outputs. - :type output_variable_mappings: List - :param step_dependencies: List of step names this step depends on. - :type step_dependencies: list - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']. - :type package_requirements: list - :param cpu_size: Size of the CPU for the step function. - :type cpu_size: str - :param memory: Memory (in GB) for the step function. - :type memory: int - :param timeout: Timeout for the pipeline step, default is 300 minutes. - :type timeout: int - - :returns: Object describing the pipeline. - :rtype: PipelineStep - - - - .. py:method:: rename(step_name) - - Renames a step in a given pipeline. - - :param step_name: The name of the step. - :type step_name: str - - :returns: Object describing the pipeline. - :rtype: PipelineStep - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PipelineStep - - - - .. py:method:: describe() - - Deletes a step from a pipeline. - - :param pipeline_step_id: The ID of the pipeline step. - :type pipeline_step_id: str - - :returns: An object describing the pipeline step. - :rtype: PipelineStep - - - -.. py:class:: PipelineStepVersion(client, stepName=None, pipelineStepVersion=None, pipelineStepId=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, status=None, error=None, outputErrors=None, pythonFunctionId=None, functionVariableMappings=None, stepDependencies=None, outputVariableMappings=None, cpuSize=None, memory=None, timeout=None, pipelineStepVersionReferences={}, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a pipeline step. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param stepName: The name of the step. - :type stepName: str - :param pipelineStepVersion: The reference to the pipeline step version. - :type pipelineStepVersion: str - :param pipelineStepId: The reference to this step. - :type pipelineStepId: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param pipelineVersion: The reference to the pipeline version. - :type pipelineVersion: str - :param createdAt: The date and time which this step was created. - :type createdAt: str - :param updatedAt: The date and time when this step was last updated. - :type updatedAt: str - :param status: The status of the pipeline version. - :type status: str - :param error: The error message if the pipeline step failed. - :type error: str - :param outputErrors: The error message of a pipeline step's output. - :type outputErrors: str - :param pythonFunctionId: The reference to the python function - :type pythonFunctionId: str - :param functionVariableMappings: The mappings for function parameters' names. - :type functionVariableMappings: dict - :param stepDependencies: List of steps this step depends on. - :type stepDependencies: list[str] - :param outputVariableMappings: The mappings for the output variables to the step. - :type outputVariableMappings: dict - :param cpuSize: CPU size specified for the step function. - :type cpuSize: str - :param memory: Memory in GB specified for the step function. - :type memory: int - :param timeout: The timeout in minutes for the pipeline step. - :type timeout: int - :param pipelineStepVersionReferences: A list to the output instances of the pipeline step version. - :type pipelineStepVersionReferences: PipelineStepVersionReference - :param codeSource: Information about the source code of the pipeline step version. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PipelineStepVersion - - - - .. py:method:: describe() - - Describes a pipeline step version. - - :param pipeline_step_version: The ID of the pipeline step version. - :type pipeline_step_version: str - - :returns: An object describing the pipeline step version. - :rtype: PipelineStepVersion - - - - .. py:method:: get_step_version_logs() - - Gets the logs for a given step version. - - :param pipeline_step_version: The id of the pipeline step version. - :type pipeline_step_version: str - - :returns: Object describing the pipeline step logs. - :rtype: PipelineStepVersionLogs - - - -.. py:class:: PipelineStepVersionLogs(client, stepName=None, pipelineStepId=None, pipelineStepVersion=None, logs=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs for a given pipeline step version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param stepName: The name of the step - :type stepName: str - :param pipelineStepId: The ID of the step - :type pipelineStepId: str - :param pipelineStepVersion: The version of the step - :type pipelineStepVersion: str - :param logs: The logs for both stdout and stderr of the step - :type logs: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PipelineVersion(client, pipelineName=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, completedAt=None, status=None, error=None, stepVersions={}, codeSource={}, pipelineVariableMappings={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a pipeline. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineName: The name of the pipeline this step is a part of. - :type pipelineName: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param pipelineVersion: The reference to this pipeline version. - :type pipelineVersion: str - :param createdAt: The date and time which this pipeline version was created. - :type createdAt: str - :param updatedAt: The date and time which this pipeline version was updated. - :type updatedAt: str - :param completedAt: The date and time which this pipeline version was updated. - :type completedAt: str - :param status: The status of the pipeline version. - :type status: str - :param error: The relevant error, if the status is FAILED. - :type error: str - :param stepVersions: A list of the pipeline step versions. - :type stepVersions: PipelineStepVersion - :param codeSource: information on the source code - :type codeSource: CodeSource - :param pipelineVariableMappings: A description of the function variables into the pipeline. - :type pipelineVariableMappings: PythonFunctionArgument - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PipelineVersion - - - - .. py:method:: describe() - - Describes a specified pipeline version - - :param pipeline_version: Unique string identifier for the pipeline version - :type pipeline_version: str - - :returns: Object describing the pipeline version - :rtype: PipelineVersion - - - - .. py:method:: reset(steps = None, include_downstream_steps = True) - - Reruns a pipeline version for the given steps and downstream steps if specified. - - :param steps: List of pipeline step names to rerun. - :type steps: list - :param include_downstream_steps: Whether to rerun downstream steps from the steps you have passed - :type include_downstream_steps: bool - - :returns: Object describing the pipeline version - :rtype: PipelineVersion - - - - .. py:method:: list_logs() - - Gets the logs for the steps in a given pipeline version. - - :param pipeline_version: The id of the pipeline version. - :type pipeline_version: str - - :returns: Object describing the logs for the steps in the pipeline. - :rtype: PipelineVersionLogs - - - - .. py:method:: skip_pending_steps() - - Skips pending steps in a pipeline version. - - :param pipeline_version: The id of the pipeline version. - :type pipeline_version: str - - :returns: Object describing the pipeline version - :rtype: PipelineVersion - - - - .. py:method:: wait_for_pipeline(timeout=1200) - - A waiting call until all the stages in a pipeline version have completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the pipeline version. - - :returns: A string describing the status of a pipeline version (pending, running, complete, etc.). - :rtype: str - - - -.. py:class:: PipelineVersionLogs(client, stepLogs={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs for a given pipeline version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param stepLogs: A list of the pipeline step version logs. - :type stepLogs: PipelineStepVersionLogs - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PredictionOperator(client, name=None, predictionOperatorId=None, createdAt=None, updatedAt=None, projectId=None, predictFunctionName=None, sourceCode=None, initializeFunctionName=None, notebookId=None, memory=None, useGpu=None, featureGroupIds=None, featureGroupTableNames=None, codeSource={}, refreshSchedules={}, latestPredictionOperatorVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A prediction operator. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name for the prediction operator. - :type name: str - :param predictionOperatorId: The unique identifier of the prediction operator. - :type predictionOperatorId: str - :param createdAt: Date and time at which the prediction operator was created. - :type createdAt: str - :param updatedAt: Date and time at which the prediction operator was updated. - :type updatedAt: str - :param projectId: The project this prediction operator belongs to. - :type projectId: str - :param predictFunctionName: Name of the function found in the source code that will be executed to run predictions. - :type predictFunctionName: str - :param sourceCode: Python code used to make the prediction operator. - :type sourceCode: str - :param initializeFunctionName: Name of the optional initialize function found in the source code. This function will generate anything used by predictions, based on input feature groups. - :type initializeFunctionName: str - :param notebookId: The unique string identifier of the notebook used to create or edit the prediction operator. - :type notebookId: str - :param memory: Memory in GB specified for the prediction operator. - :type memory: int - :param useGpu: Whether this prediction operator is using gpu. - :type useGpu: bool - :param featureGroupIds: A list of Feature Group IDs used for initializing. - :type featureGroupIds: list - :param featureGroupTableNames: A list of Feature Group table names used for initializing. - :type featureGroupTableNames: list - :param codeSource: If a python model, information on the source code. - :type codeSource: CodeSource - :param latestPredictionOperatorVersion: The unique string identifier of the latest version. - :type latestPredictionOperatorVersion: PredictionOperatorVersion - :param refreshSchedules: List of refresh schedules that indicate when the next prediction operator version will be processed - :type refreshSchedules: RefreshSchedule - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PredictionOperator - - - - .. py:method:: describe() - - Describe an existing prediction operator. - - :param prediction_operator_id: The unique ID of the prediction operator. - :type prediction_operator_id: str - - :returns: The requested prediction operator object. - :rtype: PredictionOperator - - - - .. py:method:: update(name = None, feature_group_ids = None, source_code = None, initialize_function_name = None, predict_function_name = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) - - Update an existing prediction operator. - - :param name: Name of the prediction operator. - :type name: str - :param feature_group_ids: List of feature groups that are supplied to the initialize function as parameters. Each of the parameters are materialized Dataframes. The order should match the initialize function's parameters. - :type feature_group_ids: List - :param source_code: Contents of a valid Python source code file. The source code should contain the function `predictFunctionName`, and the function 'initializeFunctionName' if defined. - :type source_code: str - :param initialize_function_name: Name of the optional initialize function found in the source code. This function will generate anything used by predictions, based on input feature groups. - :type initialize_function_name: str - :param predict_function_name: Name of the function found in the source code that will be executed to run predictions. - :type predict_function_name: str - :param cpu_size: Size of the CPU for the prediction operator. - :type cpu_size: str - :param memory: Memory (in GB) for the prediction operator. - :type memory: int - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0'] - :type package_requirements: list - :param use_gpu: Whether this prediction operator needs gpu. - :type use_gpu: bool - - :returns: The updated prediction operator object. - :rtype: PredictionOperator - - - - .. py:method:: delete() - - Delete an existing prediction operator. - - :param prediction_operator_id: The unique ID of the prediction operator. - :type prediction_operator_id: str - - - - .. py:method:: deploy(auto_deploy = True) - - Deploy the prediction operator. - - :param auto_deploy: Flag to enable the automatic deployment when a new prediction operator version is created. - :type auto_deploy: bool - - :returns: The created deployment object. - :rtype: Deployment - - - - .. py:method:: create_version() - - Create a new version of the prediction operator. - - :param prediction_operator_id: The unique ID of the prediction operator. - :type prediction_operator_id: str - - :returns: The created prediction operator version object. - :rtype: PredictionOperatorVersion - - - - .. py:method:: list_versions() - - List all the prediction operator versions for a prediction operator. - - :param prediction_operator_id: The unique ID of the prediction operator. - :type prediction_operator_id: str - - :returns: A list of prediction operator version objects. - :rtype: list[PredictionOperatorVersion] - - - -.. py:class:: PredictionOperatorVersion(client, predictionOperatorId=None, predictionOperatorVersion=None, createdAt=None, updatedAt=None, sourceCode=None, memory=None, useGpu=None, featureGroupIds=None, featureGroupVersions=None, status=None, error=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A prediction operator version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param predictionOperatorId: The unique identifier of the prediction operator. - :type predictionOperatorId: str - :param predictionOperatorVersion: The unique identifier of the prediction operator version. - :type predictionOperatorVersion: str - :param createdAt: Date and time at which the prediction operator was created. - :type createdAt: str - :param updatedAt: Date and time at which the prediction operator was updated. - :type updatedAt: str - :param sourceCode: Python code used to make the prediction operator. - :type sourceCode: str - :param memory: Memory in GB specified for the prediction operator version. - :type memory: int - :param useGpu: Whether this prediction operator version is using gpu. - :type useGpu: bool - :param featureGroupIds: A list of Feature Group IDs used for initializing. - :type featureGroupIds: list - :param featureGroupVersions: A list of Feature Group version IDs used for initializing. - :type featureGroupVersions: list - :param status: The current status of the prediction operator version. - :type status: str - :param error: The error message if the status failed. - :type error: str - :param codeSource: If a python model, information on the source code. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete a prediction operator version. - - :param prediction_operator_version: The unique ID of the prediction operator version. - :type prediction_operator_version: str - - - -.. py:class:: ProblemType(client, problemType=None, requiredFeatureGroupType=None, optionalFeatureGroupTypes=None, useCasesSupportCustomAlgorithm=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Description of a problem type which is the common underlying problem for different use cases. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param problemType: Name of the problem type - :type problemType: str - :param requiredFeatureGroupType: The required feature group types to train for this problem type - :type requiredFeatureGroupType: str - :param optionalFeatureGroupTypes: The optional feature group types can be used to train for this problem type - :type optionalFeatureGroupTypes: list[str] - :param useCasesSupportCustomAlgorithm: A list of use cases that support custom algorithms - :type useCasesSupportCustomAlgorithm: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Project(client, projectId=None, name=None, useCase=None, problemType=None, createdAt=None, tags=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A project is a container which holds datasets, models and deployments - - :param client: An authenticated API Client instance - :type client: ApiClient - :param projectId: The ID of the project. - :type projectId: str - :param name: The name of the project. - :type name: str - :param useCase: The use case associated with the project. - :type useCase: str - :param problemType: The problem type associated with the project. - :type problemType: str - :param createdAt: The date and time when the project was created. - :type createdAt: str - :param tags: List of tags associated with the project. - :type tags: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Project - - - - .. py:method:: describe() - - Returns a description of a project. - - :param project_id: A unique string identifier for the project. - :type project_id: str - - :returns: The description of the project. - :rtype: Project - - - - .. py:method:: rename(name) - - This method renames a project after it is created. - - :param name: The new name for the project. - :type name: str - - - - .. py:method:: delete() - - Delete a specified project from your organization. - - This method deletes the project, its associated trained models, and deployments. The datasets attached to the specified project remain available for use with other projects in the organization. - - This method will not delete a project that contains active deployments. Ensure that all active deployments are stopped before using the delete option. - - Note: All projects, models, and deployments cannot be recovered once they are deleted. - - - :param project_id: The unique ID of the project to delete. - :type project_id: str - - - - .. py:method:: add_tags(tags) - - This method adds a tag to a project. - - :param tags: The tags to add to the project. - :type tags: list - - - - .. py:method:: remove_tags(tags) - - This method removes a tag from a project. - - :param tags: The tags to remove from the project. - :type tags: list - - - - .. py:method:: set_feature_mapping(feature_group_id, feature_name, feature_mapping = None, nested_column_name = None) - - Set a column's feature mapping. If the column mapping is single-use and already set in another column in this feature group, this call will first remove the other column's mapping and move it to this column. - - :param feature_group_id: The unique ID associated with the feature group. - :type feature_group_id: str - :param feature_name: The name of the feature. - :type feature_name: str - :param feature_mapping: The mapping of the feature in the feature group. - :type feature_mapping: str - :param nested_column_name: The name of the nested column if the input feature is part of a nested feature group for the given feature_group_id. - :type nested_column_name: str - - :returns: A list of objects that describes the resulting feature group's schema after the feature's featureMapping is set. - :rtype: list[Feature] - - - - .. py:method:: validate(feature_group_ids = None) - - Validates that the specified project has all required feature group types for its use case and that all required feature columns are set. - - :param feature_group_ids: The list of feature group IDs to validate. - :type feature_group_ids: List - - :returns: The project validation. If the specified project is missing required columns or feature groups, the response includes an array of objects for each missing required feature group and the missing required features in each feature group. - :rtype: ProjectValidation - - - - .. py:method:: infer_feature_mappings(feature_group_id) - - Infer the feature mappings for the feature group in the project based on the problem type. - - :param feature_group_id: The unique ID associated with the feature group. - :type feature_group_id: str - - :returns: A dict that contains the inferred feature mappings. - :rtype: InferredFeatureMappings - - - - .. py:method:: describe_feature_group(feature_group_id) - - Describe a feature group associated with a project - - :param feature_group_id: The unique ID associated with the feature group. - :type feature_group_id: str - - :returns: The project feature group object. - :rtype: ProjectFeatureGroup - - - - .. py:method:: list_feature_groups(filter_feature_group_use = None, limit = 100, start_after_id = None) - - List all the feature groups associated with a project - - :param filter_feature_group_use: The feature group use filter, when given as an argument only allows feature groups present in this project to be returned if they are of the given use. Possible values are: 'USER_CREATED', 'BATCH_PREDICTION_OUTPUT'. - :type filter_feature_group_use: str - :param limit: The maximum number of feature groups to be retrieved. - :type limit: int - :param start_after_id: An offset parameter to exclude all feature groups up to a specified ID. - :type start_after_id: str - - :returns: All the Feature Groups in a project. - :rtype: list[ProjectFeatureGroup] - - - - .. py:method:: list_feature_group_templates(limit = 100, start_after_id = None, should_include_all_system_templates = False) - - List feature group templates for feature groups associated with the project. - - :param limit: Maximum number of templates to be retrieved. - :type limit: int - :param start_after_id: Offset parameter to exclude all templates till the specified feature group template ID. - :type start_after_id: str - :param should_include_all_system_templates: If True, will include built-in templates. - :type should_include_all_system_templates: bool - - :returns: All the feature groups in the organization, optionally limited by the feature group that created the template(s). - :rtype: list[FeatureGroupTemplate] - - - - .. py:method:: get_training_config_options(feature_group_ids = None, for_retrain = False, current_training_config = None) - - Retrieves the full initial description of the model training configuration options available for the specified project. The configuration options available are determined by the use case associated with the specified project. Refer to the [Use Case Documentation]({USE_CASES_URL}) for more information on use cases and use case-specific configuration options. - - :param feature_group_ids: The feature group IDs to be used for training. - :type feature_group_ids: List - :param for_retrain: Whether the training config options are used for retraining. - :type for_retrain: bool - :param current_training_config: The current state of the training config, with some options set, which shall be used to get new options after refresh. This is `None` by default initially. - :type current_training_config: TrainingConfig - - :returns: An array of options that can be specified when training a model in this project. - :rtype: list[TrainingConfigOptions] - - - - .. py:method:: create_train_test_data_split_feature_group(training_config, feature_group_ids) - - Get the train and test data split without training the model. Only supported for models with custom algorithms. - - :param training_config: The training config used to influence how the split is calculated. - :type training_config: TrainingConfig - :param feature_group_ids: List of feature group IDs provided by the user, including the required one for data split and others to influence how to split. - :type feature_group_ids: List - - :returns: The feature group containing the training data and folds information. - :rtype: FeatureGroup - - - - .. py:method:: train_model(name = None, training_config = None, feature_group_ids = None, refresh_schedule = None, custom_algorithms = None, custom_algorithms_only = False, custom_algorithm_configs = None, builtin_algorithms = None, cpu_size = None, memory = None, algorithm_training_configs = None) - - Create a new model and start its training in the given project. - - :param name: The name of the model. Defaults to " Model". - :type name: str - :param training_config: The training config used to train this model. - :type training_config: TrainingConfig - :param feature_group_ids: List of feature group IDs provided by the user to train the model on. - :type feature_group_ids: List - :param refresh_schedule: A cron-style string that describes a schedule in UTC to automatically retrain the created model. - :type refresh_schedule: str - :param custom_algorithms: List of user-defined algorithms to train. If not set, the default enabled custom algorithms will be used. - :type custom_algorithms: list - :param custom_algorithms_only: Whether to only run custom algorithms. - :type custom_algorithms_only: bool - :param custom_algorithm_configs: Configs for each user-defined algorithm; key is the algorithm name, value is the config serialized to JSON. - :type custom_algorithm_configs: dict - :param builtin_algorithms: List of algorithm names or algorithm IDs of the builtin algorithms provided by Abacus.AI to train. If not set, all applicable builtin algorithms will be used. - :type builtin_algorithms: list - :param cpu_size: Size of the CPU for the user-defined algorithms during training. - :type cpu_size: str - :param memory: Memory (in GB) for the user-defined algorithms during training. - :type memory: int - :param algorithm_training_configs: List of algorithm specifc training configs that will be part of the model training AutoML run. - :type algorithm_training_configs: list - - :returns: The new model which is being trained. - :rtype: Model - - - - .. py:method:: create_model_from_python(function_source_code, train_function_name, training_input_tables, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, name = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False, package_requirements = None, use_gpu = False, is_thread_safe = None) - - Initializes a new Model from user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. - - This method expects `functionSourceCode` to be a valid language source file which contains the functions named `trainFunctionName` and `predictFunctionName`. `trainFunctionName` returns the ModelVersion that is the result of training the model using `trainFunctionName` and `predictFunctionName` has no well-defined return type, as it returns the prediction made by the `predictFunctionName`, which can be anything. - - - :param function_source_code: Contents of a valid Python source code file. The source code should contain the functions named `trainFunctionName` and `predictFunctionName`. A list of allowed import and system libraries for each language is specified in the user functions documentation section. - :type function_source_code: str - :param train_function_name: Name of the function found in the source code that will be executed to train the model. It is not executed when this function is run. - :type train_function_name: str - :param training_input_tables: List of feature groups that are supplied to the train function as parameters. Each of the parameters are materialized Dataframes (same type as the functions return value). - :type training_input_tables: list - :param predict_function_name: Name of the function found in the source code that will be executed to run predictions through the model. It is not executed when this function is run. - :type predict_function_name: str - :param predict_many_function_name: Name of the function found in the source code that will be executed for batch prediction of the model. It is not executed when this function is run. - :type predict_many_function_name: str - :param initialize_function_name: Name of the function found in the source code to initialize the trained model before using it to make predictions using the model - :type initialize_function_name: str - :param name: The name you want your model to have. Defaults to " Model" - :type name: str - :param cpu_size: Size of the CPU for the model training function - :type cpu_size: str - :param memory: Memory (in GB) for the model training function - :type memory: int - :param training_config: Training configuration - :type training_config: TrainingConfig - :param exclusive_run: Decides if this model will be run exclusively or along with other Abacus.AI algorithms - :type exclusive_run: bool - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0'] - :type package_requirements: list - :param use_gpu: Whether this model needs gpu - :type use_gpu: bool - :param is_thread_safe: Whether this model is thread safe - :type is_thread_safe: bool - - :returns: The new model, which has not been trained. - :rtype: Model - - - - .. py:method:: list_models() - - Retrieves the list of models in the specified project. - - :param project_id: Unique string identifier associated with the project. - :type project_id: str - - :returns: A list of models. - :rtype: list[Model] - - - - .. py:method:: get_custom_train_function_info(feature_group_names_for_training = None, training_data_parameter_name_override = None, training_config = None, custom_algorithm_config = None) - - Returns information about how to call the custom train function. - - :param feature_group_names_for_training: A list of feature group table names to be used for training. - :type feature_group_names_for_training: list - :param training_data_parameter_name_override: Override from feature group type to parameter name in the train function. - :type training_data_parameter_name_override: dict - :param training_config: Training config for the options supported by the Abacus.AI platform. - :type training_config: TrainingConfig - :param custom_algorithm_config: User-defined config that can be serialized by JSON. - :type custom_algorithm_config: dict - - :returns: Information about how to call the customer-provided train function. - :rtype: CustomTrainFunctionInfo - - - - .. py:method:: create_model_monitor(prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, include_interactive_performance_analysis = False) - - Runs a model monitor for the specified project. - - :param prediction_feature_group_id: The unique ID of the prediction data feature group. - :type prediction_feature_group_id: str - :param training_feature_group_id: The unique ID of the training data feature group. - :type training_feature_group_id: str - :param name: The name you want your model monitor to have. Defaults to " Model Monitor". - :type name: str - :param refresh_schedule: A cron-style string that describes a schedule in UTC to automatically retrain the created model monitor. - :type refresh_schedule: str - :param target_value: A target positive value for the label to compute bias and PR/AUC for performance page. - :type target_value: str - :param target_value_bias: A target positive value for the label to compute bias. - :type target_value_bias: str - :param target_value_performance: A target positive value for the label to compute PR curve/AUC for performance page. - :type target_value_performance: str - :param feature_mappings: A JSON map to override features for prediction_feature_group, where keys are column names and the values are feature data use types. - :type feature_mappings: dict - :param model_id: The unique ID of the model. - :type model_id: str - :param training_feature_mappings: A JSON map to override features for training_fature_group, where keys are column names and the values are feature data use types. - :type training_feature_mappings: dict - :param feature_group_base_monitor_config: Selection strategy for the feature_group 1 with the feature group version if selected. - :type feature_group_base_monitor_config: dict - :param feature_group_comparison_monitor_config: Selection strategy for the feature_group 1 with the feature group version if selected. - :type feature_group_comparison_monitor_config: dict - :param include_interactive_performance_analysis: Whether to include interactive performance analysis. - :type include_interactive_performance_analysis: bool - - :returns: The new model monitor that was created. - :rtype: ModelMonitor - - - - .. py:method:: list_model_monitors() - - Retrieves the list of model monitors in the specified project. - - :param project_id: Unique string identifier associated with the project. - :type project_id: str - - :returns: A list of model monitors. - :rtype: list[ModelMonitor] - - - - .. py:method:: create_vision_drift_monitor(prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) - - Runs a vision drift monitor for the specified project. - - :param prediction_feature_group_id: Unique string identifier of the prediction data feature group. - :type prediction_feature_group_id: str - :param training_feature_group_id: Unique string identifier of the training data feature group. - :type training_feature_group_id: str - :param name: The name you want your model monitor to have. Defaults to " Model Monitor". - :type name: str - :param feature_mappings: A JSON map to override features for prediction_feature_group, where keys are column names and the values are feature data use types. - :type feature_mappings: dict - :param training_feature_mappings: A JSON map to override features for training_feature_group, where keys are column names and the values are feature data use types. - :type training_feature_mappings: dict - :param target_value_performance: A target positive value for the label to compute precision-recall curve/area under curve for performance page. - :type target_value_performance: str - :param refresh_schedule: A cron-style string that describes a schedule in UTC to automatically rerun the created vision drift monitor. - :type refresh_schedule: str - - :returns: The new model monitor that was created. - :rtype: ModelMonitor - - - - .. py:method:: create_nlp_drift_monitor(prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) - - Runs an NLP drift monitor for the specified project. - - :param prediction_feature_group_id: Unique string identifier of the prediction data feature group. - :type prediction_feature_group_id: str - :param training_feature_group_id: Unique string identifier of the training data feature group. - :type training_feature_group_id: str - :param name: The name you want your model monitor to have. Defaults to " Model Monitor". - :type name: str - :param feature_mappings: A JSON map to override features for prediction_feature_group, where keys are column names and the values are feature data use types. - :type feature_mappings: dict - :param training_feature_mappings: A JSON map to override features for training_feature_group, where keys are column names and the values are feature data use types. - :type training_feature_mappings: dict - :param target_value_performance: A target positive value for the label to compute precision-recall curve/area under curve for performance page. - :type target_value_performance: str - :param refresh_schedule: A cron-style string that describes a schedule in UTC to automatically rerun the created nlp drift monitor. - :type refresh_schedule: str - - :returns: The new model monitor that was created. - :rtype: ModelMonitor - - - - .. py:method:: create_forecasting_monitor(name, prediction_feature_group_id, training_feature_group_id, training_forecast_config, prediction_forecast_config, forecast_frequency, refresh_schedule = None) - - Runs a forecasting monitor for the specified project. - - :param name: The name you want your model monitor to have. Defaults to " Model Monitor". - :type name: str - :param prediction_feature_group_id: Unique string identifier of the prediction data feature group. - :type prediction_feature_group_id: str - :param training_feature_group_id: Unique string identifier of the training data feature group. - :type training_feature_group_id: str - :param training_forecast_config: The configuration for the training data. - :type training_forecast_config: ForecastingMonitorConfig - :param prediction_forecast_config: The configuration for the prediction data. - :type prediction_forecast_config: ForecastingMonitorConfig - :param forecast_frequency: The frequency of the forecast. Defaults to the frequency of the prediction data. - :type forecast_frequency: str - :param refresh_schedule: A cron-style string that describes a schedule in UTC to automatically rerun the created forecasting monitor. - :type refresh_schedule: str - - :returns: The new model monitor that was created. - :rtype: ModelMonitor - - - - .. py:method:: create_eda(feature_group_id, name, refresh_schedule = None, include_collinearity = False, include_data_consistency = False, collinearity_keys = None, primary_keys = None, data_consistency_test_config = None, data_consistency_reference_config = None, feature_mappings = None, forecast_frequency = None) - - Run an Exploratory Data Analysis (EDA) for the specified project. - - :param feature_group_id: The unique ID of the prediction data feature group. - :type feature_group_id: str - :param name: The name you want your model monitor to have. Defaults to " EDA". - :type name: str - :param refresh_schedule: A cron-style string that describes a schedule in UTC to automatically retrain the created EDA. - :type refresh_schedule: str - :param include_collinearity: Set to True if the EDA type is collinearity. - :type include_collinearity: bool - :param include_data_consistency: Set to True if the EDA type is data consistency. - :type include_data_consistency: bool - :param collinearity_keys: List of features to use for collinearity - :type collinearity_keys: list - :param primary_keys: List of features that corresponds to the primary keys or item ids for the given feature group for Data Consistency analysis or Forecasting analysis respectively. - :type primary_keys: list - :param data_consistency_test_config: Test feature group version selection strategy for Data Consistency EDA type. - :type data_consistency_test_config: dict - :param data_consistency_reference_config: Reference feature group version selection strategy for Data Consistency EDA type. - :type data_consistency_reference_config: dict - :param feature_mappings: A JSON map to override features for the given feature_group, where keys are column names and the values are feature data use types. (In forecasting, used to set the timestamp column and target value) - :type feature_mappings: dict - :param forecast_frequency: The frequency of the data. It can be either HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY. - :type forecast_frequency: str - - :returns: The new EDA object that was created. - :rtype: Eda - - - - .. py:method:: list_eda() - - Retrieves the list of Exploratory Data Analysis (EDA) in the specified project. - - :param project_id: Unique string identifier associated with the project. - :type project_id: str - - :returns: List of EDA objects. - :rtype: list[Eda] - - - - .. py:method:: list_holdout_analysis(model_id = None) - - List holdout analyses for a project. Optionally, filter by model. - - :param model_id: (optional) ID of the model to filter by - :type model_id: str - - :returns: The holdout analyses - :rtype: list[HoldoutAnalysis] - - - - .. py:method:: create_monitor_alert(alert_name, condition_config, action_config, model_monitor_id = None, realtime_monitor_id = None) - - Create a monitor alert for the given conditions and monitor. We can create monitor alert either for model monitor or real-time monitor. - - :param alert_name: Name of the alert. - :type alert_name: str - :param condition_config: Condition to run the actions for the alert. - :type condition_config: AlertConditionConfig - :param action_config: Configuration for the action of the alert. - :type action_config: AlertActionConfig - :param model_monitor_id: Unique string identifier for the model monitor created under the project. - :type model_monitor_id: str - :param realtime_monitor_id: Unique string identifier for the real-time monitor for the deployment created under the project. - :type realtime_monitor_id: str - - :returns: Object describing the monitor alert. - :rtype: MonitorAlert - - - - .. py:method:: list_prediction_operators() - - List all the prediction operators inside a project. - - :param project_id: The unique ID of the project. - :type project_id: str - - :returns: A list of prediction operator objects. - :rtype: list[PredictionOperator] - - - - .. py:method:: create_deployment_token(name = None) - - Creates a deployment token for the specified project. - - Deployment tokens are used to authenticate requests to the prediction APIs and are scoped to the project level. - - - :param name: The name of the deployment token. - :type name: str - - :returns: The deployment token. - :rtype: DeploymentAuthToken - - - - .. py:method:: list_deployments() - - Retrieves a list of all deployments in the specified project. - - :param project_id: The unique identifier associated with the project. - :type project_id: str - - :returns: An array of deployments. - :rtype: list[Deployment] - - - - .. py:method:: list_deployment_tokens() - - Retrieves a list of all deployment tokens associated with the specified project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - :returns: A list of deployment tokens. - :rtype: list[DeploymentAuthToken] - - - - .. py:method:: list_realtime_monitors() - - List the real-time monitors associated with the deployment id. - - :param project_id: Unique string identifier for the deployment. - :type project_id: str - - :returns: An array of real-time monitors. - :rtype: list[RealtimeMonitor] - - - - .. py:method:: list_refresh_policies(dataset_ids = [], feature_group_id = None, model_ids = [], deployment_ids = [], batch_prediction_ids = [], model_monitor_ids = [], notebook_ids = []) - - List the refresh policies for the organization. If no filters are specified, all refresh policies are returned. - - :param dataset_ids: Comma-separated list of Dataset IDs. - :type dataset_ids: List - :param feature_group_id: Feature Group ID for which we wish to see the refresh policies attached. - :type feature_group_id: str - :param model_ids: Comma-separated list of Model IDs. - :type model_ids: List - :param deployment_ids: Comma-separated list of Deployment IDs. - :type deployment_ids: List - :param batch_prediction_ids: Comma-separated list of Batch Prediction IDs. - :type batch_prediction_ids: List - :param model_monitor_ids: Comma-separated list of Model Monitor IDs. - :type model_monitor_ids: List - :param notebook_ids: Comma-separated list of Notebook IDs. - :type notebook_ids: List - - :returns: List of all refresh policies in the organization. - :rtype: list[RefreshPolicy] - - - - .. py:method:: list_batch_predictions() - - Retrieves a list of batch predictions in the project. - - :param project_id: Unique string identifier of the project. - :type project_id: str - - :returns: List of batch prediction jobs. - :rtype: list[BatchPrediction] - - - - .. py:method:: list_pipelines() - - Lists the pipelines for an organization or a project - - :param project_id: Unique string identifier for the project to list graph dashboards from. - :type project_id: str - - :returns: A list of pipelines. - :rtype: list[Pipeline] - - - - .. py:method:: create_graph_dashboard(name, python_function_ids = None) - - Create a plot dashboard given selected python plots - - :param name: The name of the dashboard. - :type name: str - :param python_function_ids: A list of unique string identifiers for the python functions to be used in the graph dashboard. - :type python_function_ids: List - - :returns: An object describing the graph dashboard. - :rtype: GraphDashboard - - - - .. py:method:: list_graph_dashboards() - - Lists the graph dashboards for a project - - :param project_id: Unique string identifier for the project to list graph dashboards from. - :type project_id: str - - :returns: A list of graph dashboards. - :rtype: list[GraphDashboard] - - - - .. py:method:: list_builtin_algorithms(feature_group_ids, training_config = None) - - Return list of built-in algorithms based on given input data and training config. - - :param feature_group_ids: List of feature group IDs specifying input data. - :type feature_group_ids: List - :param training_config: The training config to be used for model training. - :type training_config: TrainingConfig - - :returns: List of applicable builtin algorithms. - :rtype: list[Algorithm] - - - - .. py:method:: create_chat_session(name = None) - - Creates a chat session with Data Science Co-pilot. - - :param name: The name of the chat session. Defaults to the project name. - :type name: str - - :returns: The chat session with Data Science Co-pilot - :rtype: ChatSession - - - - .. py:method:: create_agent(function_source_code = None, agent_function_name = None, name = None, memory = None, package_requirements = None, description = None, enable_binary_input = False, evaluation_feature_group_id = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = AgentInterface.DEFAULT) - - Creates a new AI agent using the given agent workflow graph definition. - - :param name: The name you want your agent to have, defaults to " Agent". - :type name: str - :param memory: Overrides the default memory allocation (in GB) for the agent. - :type memory: int - :param description: A description of the agent, including its purpose and instructions. - :type description: str - :param evaluation_feature_group_id: The ID of the feature group to use for evaluation. - :type evaluation_feature_group_id: str - :param workflow_graph: The workflow graph for the agent. - :type workflow_graph: WorkflowGraph - :param agent_interface: The interface that the agent will be deployed with. - :type agent_interface: AgentInterface - - :returns: The new agent. - :rtype: Agent - - - - .. py:method:: list_agents() - - Retrieves the list of agents in the specified project. - - :param project_id: The unique identifier associated with the project. - :type project_id: str - - :returns: A list of agents in the project. - :rtype: list[Agent] - - - - .. py:method:: create_document_retriever(name, feature_group_id, document_retriever_config = None) - - Returns a document retriever that stores embeddings for document chunks in a feature group. - - Document columns in the feature group are broken into chunks. For cases with multiple document columns, chunks from all columns are combined together to form a single chunk. - - - :param name: The name of the Document Retriever. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type name: str - :param feature_group_id: The ID of the feature group that the Document Retriever is associated with. - :type feature_group_id: str - :param document_retriever_config: The configuration, including chunk_size and chunk_overlap_fraction, for document retrieval. - :type document_retriever_config: VectorStoreConfig - - :returns: The newly created document retriever. - :rtype: DocumentRetriever - - - - .. py:method:: list_document_retrievers(limit = 100, start_after_id = None) - - List all the document retrievers. - - :param limit: The number of document retrievers to return. - :type limit: int - :param start_after_id: An offset parameter to exclude all document retrievers up to this specified ID. - :type start_after_id: str - - :returns: All the document retrievers in the organization associated with the specified project. - :rtype: list[DocumentRetriever] - - - - .. py:method:: create_model_from_functions(train_function, predict_function = None, training_input_tables = None, predict_many_function = None, initialize_function = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False) - - Creates a model using python. - - :param train_function: The train function is passed. - :type train_function: callable - :param predict_function: The prediction function is passed. - :type predict_function: callable - :param training_input_tables: The input tables to be used for training the model. Defaults to None. - :type training_input_tables: list - :param predict_many_function: Prediction function for batch input - :type predict_many_function: callable - :param cpu_size: Size of the cpu for the feature group function - :type cpu_size: str - :param memory: Memory (in GB) for the feature group function - :type memory: int - - :returns: The model object. - :rtype: Model - - - -.. py:class:: ProjectConfig(client, type=None, config={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Project-specific config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: Type of project config - :type type: str - :param config: Project-specific config for this feature group - :type config: ProjectFeatureGroupConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ProjectFeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, featureGroupType=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, projectFeatureGroupSchema={}, projectConfig={}, latestFeatureGroupVersion={}) - - Bases: :py:obj:`abacusai.feature_group.FeatureGroup` - - - A feature group along with project specific mappings - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: Unique identifier for this feature group. - :type featureGroupId: str - :param modificationLock: If feature group is locked against a change or not. - :type modificationLock: bool - :param name: - :type name: str - :param featureGroupSourceType: The source type of the feature group - :type featureGroupSourceType: str - :param tableName: Unique table name of this feature group. - :type tableName: str - :param sql: SQL definition creating this feature group. - :type sql: str - :param datasetId: Dataset ID the feature group is sourced from. - :type datasetId: str - :param functionSourceCode: Source definition creating this feature group. - :type functionSourceCode: str - :param functionName: Function name to execute from the source code. - :type functionName: str - :param sourceTables: Source tables for this feature group. - :type sourceTables: list[str] - :param createdAt: Timestamp at which the feature group was created. - :type createdAt: str - :param description: Description of the feature group. - :type description: str - :param sqlError: Error message with this feature group. - :type sqlError: str - :param latestVersionOutdated: Is latest materialized feature group version outdated. - :type latestVersionOutdated: bool - :param referencedFeatureGroups: Feature groups this feature group is used in. - :type referencedFeatureGroups: list[str] - :param tags: Tags added to this feature group. - :type tags: list[str] - :param primaryKey: Primary index feature. - :type primaryKey: str - :param updateTimestampKey: Primary timestamp feature. - :type updateTimestampKey: str - :param lookupKeys: Additional indexed features for this feature group. - :type lookupKeys: list[str] - :param streamingEnabled: If true, the feature group can have data streamed to it. - :type streamingEnabled: bool - :param incremental: If feature group corresponds to an incremental dataset. - :type incremental: bool - :param mergeConfig: Merge configuration settings for the feature group. - :type mergeConfig: dict - :param operatorConfig: Operator configuration settings for the feature group. - :type operatorConfig: dict - :param samplingConfig: Sampling configuration for the feature group. - :type samplingConfig: dict - :param cpuSize: CPU size specified for the Python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the Python feature group. - :type memory: int - :param streamingReady: If true, the feature group is ready to receive streaming data. - :type streamingReady: bool - :param featureTags: Tags for features in this feature group - :type featureTags: dict - :param moduleName: Path to the file with the feature group function. - :type moduleName: str - :param templateBindings: Config specifying variable names and values to use when resolving a feature group template. - :type templateBindings: dict - :param featureExpression: If the dataset feature group has custom features, the SQL select expression creating those features. - :type featureExpression: str - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: dict - :param pythonFunctionName: Name of the Python function the feature group was built from. - :type pythonFunctionName: str - :param useGpu: Whether this feature group is using gpu - :type useGpu: bool - :param featureGroupType: Project type when the feature group is used in the context of a project. - :type featureGroupType: str - :param features: List of resolved features. - :type features: Feature - :param duplicateFeatures: List of duplicate features. - :type duplicateFeatures: Feature - :param pointInTimeGroups: List of Point In Time Groups. - :type pointInTimeGroups: PointInTimeGroup - :param annotationConfig: Annotation config for this feature - :type annotationConfig: AnnotationConfig - :param latestFeatureGroupVersion: Latest feature group version. - :type latestFeatureGroupVersion: FeatureGroupVersion - :param concatenationConfig: Feature group ID whose data will be concatenated into this feature group. - :type concatenationConfig: ConcatenationConfig - :param indexingConfig: Indexing config for the feature group for feature store - :type indexingConfig: IndexingConfig - :param codeSource: If a Python feature group, information on the source code. - :type codeSource: CodeSource - :param featureGroupTemplate: FeatureGroupTemplate to use when this feature group is attached to a template. - :type featureGroupTemplate: FeatureGroupTemplate - :param explanation: Natural language explanation of the feature group - :type explanation: NaturalLanguageExplanation - :param refreshSchedules: List of schedules that determines when the next version of the feature group will be created. - :type refreshSchedules: RefreshSchedule - :param projectFeatureGroupSchema: Project-specific schema for this feature group. - :type projectFeatureGroupSchema: ProjectFeatureGroupSchema - :param projectConfig: Project-specific config for this feature group. - :type projectConfig: ProjectConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ProjectValidation(client, valid=None, datasetErrors=None, columnHints=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A validation result for a project - - :param client: An authenticated API Client instance - :type client: ApiClient - :param valid: `true` if the project is valid and ready to be trained, otherwise `false`. - :type valid: bool - :param datasetErrors: A list of errors keeping the dataset from being valid - :type datasetErrors: list[dict] - :param columnHints: Hints for what to set on the columns - :type columnHints: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PythonFunction(client, notebookId=None, name=None, createdAt=None, functionVariableMappings=None, outputVariableMappings=None, functionName=None, pythonFunctionId=None, functionType=None, packageRequirements=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Customer created python function - - :param client: An authenticated API Client instance - :type client: ApiClient - :param notebookId: The unique identifier of the notebook used to spin up the notebook upon creation. - :type notebookId: str - :param name: The name to identify the algorithm, only uppercase letters, numbers, and underscores allowed (i.e. it must be a valid Python identifier) - :type name: str - :param createdAt: The ISO-8601 string representing when the Python function was created. - :type createdAt: str - :param functionVariableMappings: A description of the function variables. - :type functionVariableMappings: dict - :param outputVariableMappings: A description of the variables returned by the function - :type outputVariableMappings: dict - :param functionName: The name of the Python function to be used. - :type functionName: str - :param pythonFunctionId: The unique identifier of the Python function. - :type pythonFunctionId: str - :param functionType: The type of the Python function. - :type functionType: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param codeSource: Information about the source code of the Python function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: add_graph_to_dashboard(graph_dashboard_id, function_variable_mappings = None, name = None) - - Add a python plot function to a dashboard - - :param graph_dashboard_id: Unique string identifier for the graph dashboard to update. - :type graph_dashboard_id: str - :param function_variable_mappings: List of arguments to be supplied to the function as parameters, in the format [{'name': 'function_argument', 'variable_type': 'FEATURE_GROUP', 'value': 'name_of_feature_group'}]. - :type function_variable_mappings: List - :param name: Name of the added python plot - :type name: str - - :returns: An object describing the graph dashboard. - :rtype: GraphDashboard - - - - .. py:method:: validate_locally(kwargs = None) - - Validates a Python function by running it with the given input values in an local environment. Taking Input Feature Group as either name(string) or Pandas DataFrame in kwargs. - - :param kwargs: A dictionary mapping function arguments to values to pass to the function. Feature group names will automatically be converted into pandas dataframes. - :type kwargs: dict - - :returns: The result of executing the python function - :rtype: any - - :raises TypeError: If an Input Feature Group argument has an invalid type or argument is missing. - :raises Exception: If an error occurs while validating the Python function. - - - -.. py:class:: PythonPlotFunction(client, notebookId=None, name=None, createdAt=None, functionVariableMappings=None, functionName=None, pythonFunctionId=None, functionType=None, plotName=None, graphReferenceId=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Create a Plot for a Dashboard - - :param client: An authenticated API Client instance - :type client: ApiClient - :param notebookId: Unique string identifier of the notebook used to spin up the notebook upon creation. - :type notebookId: str - :param name: The name used to identify the algorithm. Only uppercase letters, numbers, and underscores are allowed. - :type name: str - :param createdAt: Date and time when the Python function was created, in ISO-8601 format. - :type createdAt: str - :param functionVariableMappings: The mappings for function parameters' names. - :type functionVariableMappings: dict - :param functionName: The name of the Python function to be used. - :type functionName: str - :param pythonFunctionId: Unique string identifier of the Python function. - :type pythonFunctionId: str - :param functionType: The type of the Python function. - :type functionType: str - :param plotName: Name of the plot. - :type plotName: str - :param graphReferenceId: Reference ID of the dashboard to the plot. - :type graphReferenceId: str - :param codeSource: Info about the source code of the Python function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: RealtimeMonitor(client, realtimeMonitorId=None, name=None, createdAt=None, deploymentId=None, lookbackTime=None, realtimeMonitorSchedule=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A real-time monitor - - :param client: An authenticated API Client instance - :type client: ApiClient - :param realtimeMonitorId: The unique identifier of the real-time monitor. - :type realtimeMonitorId: str - :param name: The user-friendly name for the real-time monitor. - :type name: str - :param createdAt: Date and time at which the real-time monitor was created. - :type createdAt: str - :param deploymentId: Deployment ID that this real-time monitor is monitoring. - :type deploymentId: str - :param lookbackTime: The lookback time for the real-time monitor. - :type lookbackTime: int - :param realtimeMonitorSchedule: The drift computation schedule for the real-time monitor. - :type realtimeMonitorSchedule: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: update(realtime_monitor_schedule = None, lookback_time = None) - - Update the real-time monitor associated with the real-time monitor id. - - :param realtime_monitor_schedule: The cron expression for triggering monitor - :type realtime_monitor_schedule: str - :param lookback_time: Lookback time (in seconds) for each monitor trigger - :type lookback_time: float - - :returns: Object describing the realtime monitor. - :rtype: RealtimeMonitor - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: RealtimeMonitor - - - - .. py:method:: describe() - - Get the real-time monitor associated with the real-time monitor id. - - :param realtime_monitor_id: Unique string identifier for the real-time monitor. - :type realtime_monitor_id: str - - :returns: Object describing the real-time monitor. - :rtype: RealtimeMonitor - - - - .. py:method:: delete() - - Delete the real-time monitor associated with the real-time monitor id. - - :param realtime_monitor_id: Unique string identifier for the real-time monitor. - :type realtime_monitor_id: str - - - -.. py:class:: RefreshPipelineRun(client, refreshPipelineRunId=None, refreshPolicyId=None, createdAt=None, startedAt=None, completedAt=None, status=None, refreshType=None, datasetVersions=None, featureGroupVersion=None, modelVersions=None, deploymentVersions=None, batchPredictions=None, refreshPolicy={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - This keeps track of the overall status of a refresh. A refresh can span multiple resources such as the creation of new dataset versions and the training of a new model version based on them. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPipelineRunId: The unique identifier for the refresh pipeline run. - :type refreshPipelineRunId: str - :param refreshPolicyId: Populated when the run was triggered by a refresh policy. - :type refreshPolicyId: str - :param createdAt: The time when this refresh pipeline run was created, in ISO-8601 format. - :type createdAt: str - :param startedAt: The time when the refresh pipeline run was started, in ISO-8601 format. - :type startedAt: str - :param completedAt: The time when the refresh pipeline run was completed, in ISO-8601 format. - :type completedAt: str - :param status: The status of the refresh pipeline run. - :type status: str - :param refreshType: The type of refresh policy to be run. - :type refreshType: str - :param datasetVersions: A list of dataset version IDs that this refresh pipeline run is monitoring. - :type datasetVersions: list[str] - :param featureGroupVersion: The feature group version ID that this refresh pipeline run is monitoring. - :type featureGroupVersion: str - :param modelVersions: A list of model version IDs that this refresh pipeline run is monitoring. - :type modelVersions: list[str] - :param deploymentVersions: A list of deployment version IDs that this refresh pipeline run is monitoring. - :type deploymentVersions: list[str] - :param batchPredictions: A list of batch prediction IDs that this refresh pipeline run is monitoring. - :type batchPredictions: list[str] - :param refreshPolicy: The refresh policy for this refresh policy run. - :type refreshPolicy: RefreshPolicy - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: RefreshPipelineRun - - - - .. py:method:: describe() - - Retrieve a single refresh pipeline run - - :param refresh_pipeline_run_id: Unique string identifier associated with the refresh pipeline run. - :type refresh_pipeline_run_id: str - - :returns: A refresh pipeline run object. - :rtype: RefreshPipelineRun - - - - .. py:method:: wait_for_complete(timeout=None) - - A waiting call until refresh pipeline run has completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the refresh pipeline run. - - :returns: A string describing the status of a refresh pipeline run (pending, complete, etc.). - :rtype: str - - - -.. py:class:: RefreshPolicy(client, refreshPolicyId=None, name=None, cron=None, nextRunTime=None, createdAt=None, refreshType=None, projectId=None, datasetIds=None, featureGroupId=None, modelIds=None, deploymentIds=None, batchPredictionIds=None, modelMonitorIds=None, notebookId=None, paused=None, predictionOperatorId=None, pipelineId=None, featureGroupExportConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier for the refresh policy - :type refreshPolicyId: str - :param name: The user-friendly name for the refresh policy - :type name: str - :param cron: A cron-style string that describes when this refresh policy is to be executed in UTC - :type cron: str - :param nextRunTime: The next UTC time that this refresh policy will be executed - :type nextRunTime: str - :param createdAt: The time when the refresh policy was created - :type createdAt: str - :param refreshType: The type of refresh policy to be run - :type refreshType: str - :param projectId: The unique identifier of a project that this refresh policy applies to - :type projectId: str - :param datasetIds: Comma-separated list of Dataset IDs that this refresh policy applies to - :type datasetIds: list[str] - :param featureGroupId: Feature Group ID that this refresh policy applies to - :type featureGroupId: str - :param modelIds: Comma-separated list of Model IDs that this refresh policy applies to - :type modelIds: list[str] - :param deploymentIds: Comma-separated list of Deployment IDs that this refresh policy applies to - :type deploymentIds: list[str] - :param batchPredictionIds: Comma-separated list of Batch Prediction IDs that this refresh policy applies to - :type batchPredictionIds: list[str] - :param modelMonitorIds: Comma-separated list of Model Monitor IDs that this refresh policy applies to - :type modelMonitorIds: list[str] - :param notebookId: Notebook ID that this refresh policy applies to - :type notebookId: str - :param paused: True if the refresh policy is paused - :type paused: bool - :param predictionOperatorId: Prediction Operator ID that this refresh policy applies to - :type predictionOperatorId: str - :param pipelineId: The Pipeline ID With The Cron Schedule - :type pipelineId: str - :param featureGroupExportConfig: The export configuration for the feature group. Only applicable if refresh_type is FEATUREGROUP. - :type featureGroupExportConfig: FeatureGroupRefreshExportConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete a refresh policy. - - :param refresh_policy_id: Unique string identifier associated with the refresh policy to delete. - :type refresh_policy_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: RefreshPolicy - - - - .. py:method:: describe() - - Retrieve a single refresh policy - - :param refresh_policy_id: The unique ID associated with this refresh policy. - :type refresh_policy_id: str - - :returns: An object representing the refresh policy. - :rtype: RefreshPolicy - - - - .. py:method:: list_refresh_pipeline_runs() - - List the the times that the refresh policy has been run - - :param refresh_policy_id: Unique identifier associated with the refresh policy. - :type refresh_policy_id: str - - :returns: List of refresh pipeline runs for the given refresh policy ID. - :rtype: list[RefreshPipelineRun] - - - - .. py:method:: pause() - - Pauses a refresh policy - - :param refresh_policy_id: Unique identifier associated with the refresh policy to be paused. - :type refresh_policy_id: str - - - - .. py:method:: resume() - - Resumes a refresh policy - - :param refresh_policy_id: The unique ID associated with this refresh policy. - :type refresh_policy_id: str - - - - .. py:method:: run() - - Force a run of the refresh policy. - - :param refresh_policy_id: Unique string identifier associated with the refresh policy to be run. - :type refresh_policy_id: str - - - - .. py:method:: update(name = None, cron = None, feature_group_export_config = None) - - Update the name or cron string of a refresh policy - - :param name: Name of the refresh policy to be updated. - :type name: str - :param cron: Cron string describing the schedule from the refresh policy to be updated. - :type cron: str - :param feature_group_export_config: Feature group export configuration to update a feature group refresh policy. - :type feature_group_export_config: FeatureGroupExportConfig - - :returns: Updated refresh policy. - :rtype: RefreshPolicy - - - -.. py:class:: ResolvedFeatureGroupTemplate(client, featureGroupTemplateId=None, resolvedVariables=None, resolvedSql=None, templateSql=None, sqlError=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Final SQL from resolving a feature group template. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupTemplateId: Unique identifier for this feature group template. - :type featureGroupTemplateId: str - :param resolvedVariables: Map from template variable names to parameters available during template resolution. - :type resolvedVariables: dict - :param resolvedSql: SQL resulting from resolving the SQL template by applying the resolved bindings. - :type resolvedSql: str - :param templateSql: SQL that can include variables to be replaced by values from the template config to resolve this template SQL into a valid SQL query for a feature group. - :type templateSql: str - :param sqlError: if invalid, the sql error message - :type sqlError: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: _get_attribute_as_dict(attribute) - - -.. py:class:: Schema(client, name=None, featureMapping=None, detectedFeatureMapping=None, featureType=None, detectedFeatureType=None, dataType=None, detectedDataType=None, nestedFeatures={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the feature. - :type name: str - :param featureMapping: The mapping of the feature. The possible values will be based on the project's use-case. See the (Use Case Documentation)[https://api.abacus.ai/app/help/useCases] for more details. - :type featureMapping: str - :param detectedFeatureMapping: Detected feature mapping for this feature - :type detectedFeatureMapping: str - :param featureType: The underlying data type of each feature: CATEGORICAL, CATEGORICAL_LIST, NUMERICAL, TIMESTAMP, TEXT, EMAIL, LABEL_LIST, ENTITY_LABEL_LIST, PAGE_LABEL_LIST, JSON, OBJECT_REFERENCE, MULTICATEGORICAL_LIST, COORDINATE_LIST, NUMERICAL_LIST, TIMESTAMP_LIST, ZIPCODE, URL, PAGE_INFOS, PAGES_DOCUMENT, TOKENS_DOCUMENT. - :type featureType: str - :param detectedFeatureType: The detected feature type for this feature - :type detectedFeatureType: str - :param dataType: The underlying data type of each feature: INTEGER, FLOAT, STRING, DATE, DATETIME, BOOLEAN, LIST, STRUCT, NULL, BINARY. - :type dataType: str - :param detectedDataType: The detected data type for this feature - :type detectedDataType: str - :param nestedFeatures: List of features of nested feature - :type nestedFeatures: NestedFeatureSchema - :param pointInTimeInfo: Point in time information for this feature - :type pointInTimeInfo: PointInTimeFeatureInfo - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: StreamingAuthToken(client, streamingToken=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A streaming authentication token that is used to authenticate requests to append data to streaming datasets - - :param client: An authenticated API Client instance - :type client: ApiClient - :param streamingToken: The unique token used to authenticate requests - :type streamingToken: str - :param createdAt: When the token was created - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: StreamingConnector(client, streamingConnectorId=None, service=None, name=None, createdAt=None, status=None, auth=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A connector to an external service - - :param client: An authenticated API Client instance - :type client: ApiClient - :param streamingConnectorId: The unique ID for the connection. - :type streamingConnectorId: str - :param service: The service this connection connects to - :type service: str - :param name: A user-friendly name for the service - :type name: str - :param createdAt: When the API key was created - :type createdAt: str - :param status: The status of the Database Connector - :type status: str - :param auth: Non-secret connection information for this connector - :type auth: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: verify() - - Checks to see if Abacus.AI can access the streaming connector. - - :param streaming_connector_id: Unique string identifier for the streaming connector to be checked for Abacus.AI access. - :type streaming_connector_id: str - - - - .. py:method:: rename(name) - - Renames a Streaming Connector - - :param name: A new name for the streaming connector. - :type name: str - - - - .. py:method:: delete() - - Delete a streaming connector. - - :param streaming_connector_id: The unique identifier for the streaming connector. - :type streaming_connector_id: str - - - -.. py:class:: TrainingConfigOptions(client, name=None, dataType=None, valueType=None, valueOptions=None, value=None, default=None, options=None, description=None, required=None, lastModelValue=None, needsRefresh=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Training options for a model - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the parameter - :type name: str - :param dataType: The type of input required for this option - :type dataType: str - :param valueType: If the data_type is of type DICT_VALUES, this field specifies the expected value type of the values - :type valueType: str - :param valueOptions: The list of valid values for DICT_VALUES - :type valueOptions: list[str] - :param value: The value of this option - :type value: optional[str, int, float, bool] - :param default: The default value for this option - :type default: optional[str, int, float, bool] - :param options: A list of options for this parameter - :type options: list[dict] - :param description: A description of the parameter - :type description: str - :param required: True if the parameter is required for training - :type required: bool - :param lastModelValue: The last value used to train a model in this project - :type lastModelValue: optional[str, int, float, bool] - :param needsRefresh: True if training config needs to be fetched again when this config option is changed - :type needsRefresh: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Upload(client, uploadId=None, datasetUploadId=None, status=None, datasetId=None, datasetVersion=None, modelId=None, modelVersion=None, batchPredictionId=None, parts=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Upload Reference for uploading file parts - - :param client: An authenticated API Client instance - :type client: ApiClient - :param uploadId: The unique ID generated when the upload process of the full large file in smaller parts is initiated. - :type uploadId: str - :param datasetUploadId: Same as upload_id. It is kept for backwards compatibility purposes. - :type datasetUploadId: str - :param status: The current status of the upload. - :type status: str - :param datasetId: A reference to the dataset this upload is adding data to. - :type datasetId: str - :param datasetVersion: A reference to the dataset version the upload is adding data to. - :type datasetVersion: str - :param modelId: A reference the model the upload is creating a version for - :type modelId: str - :param modelVersion: A reference to the model version the upload is creating. - :type modelVersion: str - :param batchPredictionId: A reference to the batch prediction the upload is creating. - :type batchPredictionId: str - :param parts: A list containing the order of the file parts that have been uploaded. - :type parts: list[dict] - :param createdAt: The timestamp at which the upload was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: cancel() - - Cancels an upload. - - :param upload_id: A unique string identifier for the upload. - :type upload_id: str - - - - .. py:method:: part(part_number, part_data) - - Uploads part of a large dataset file from your bucket to our system. Our system currently supports parts of up to 5GB and full files of up to 5TB. Note that each part must be at least 5MB in size, unless it is the last part in the sequence of parts for the full file. - - :param part_number: The 1-indexed number denoting the position of the file part in the sequence of parts for the full file. - :type part_number: int - :param part_data: The multipart/form-data for the current part of the full file. - :type part_data: io.TextIOBase - - :returns: The object 'UploadPart' which encapsulates the hash and the etag for the part that got uploaded. - :rtype: UploadPart - - - - .. py:method:: mark_complete() - - Marks an upload process as complete. - - :param upload_id: A unique string identifier for the upload process. - :type upload_id: str - - :returns: The upload object associated with the process, containing details of the file. - :rtype: Upload - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Upload - - - - .. py:method:: describe() - - Retrieves the current upload status (complete or inspecting) and the list of file parts uploaded for a specified dataset upload. - - :param upload_id: The unique ID associated with the file uploaded or being uploaded in parts. - :type upload_id: str - - :returns: Details associated with the large dataset file uploaded in parts. - :rtype: Upload - - - - .. py:method:: upload_part(upload_args) - - Uploads a file part. - - :returns: The object 'UploadPart' that encapsulates the hash and the etag for the part that got uploaded. - :rtype: UploadPart - - - - .. py:method:: upload_file(file, threads=10, chunksize=1024 * 1024 * 10, wait_timeout=600) - - Uploads the file in the specified chunk size using the specified number of workers. - - :param file: A bytesIO or StringIO object to upload to Abacus.AI - :type file: IOBase - :param threads: The max number of workers to use while uploading the file - :type threads: int - :param chunksize: The number of bytes to use for each chunk while uploading the file. Defaults to 10 MB - :type chunksize: int - :param wait_timeout: The max number of seconds to wait for the file parts to be joined on Abacus.AI. Defaults to 600. - :type wait_timeout: int - - :returns: The upload file object. - :rtype: Upload - - - - .. py:method:: _yield_upload_part(file, chunksize) - - - .. py:method:: wait_for_join(timeout=600) - - A waiting call until the upload parts are joined. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to have timed out. Defaults to 600. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the upload. - - :returns: A string describing the status of the upload (pending, complete, etc.). - :rtype: str - - - -.. py:class:: UploadPart(client, etag=None, md5=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Unique identifiers for a part - - :param client: An authenticated API Client instance - :type client: ApiClient - :param etag: A unique string for this part. - :type etag: str - :param md5: The MD5 hash of this part. - :type md5: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: UseCase(client, useCase=None, prettyName=None, description=None, problemType=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Project Use Case - - :param client: An authenticated API Client instance - :type client: ApiClient - :param useCase: The enum value for this use case - :type useCase: str - :param prettyName: A user-friendly name - :type prettyName: str - :param description: A description for this use case - :type description: str - :param problemType: Name for the underlying problem type - :type problemType: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: UseCaseRequirements(client, datasetType=None, name=None, description=None, required=None, multi=None, allowedFeatureMappings=None, allowedNestedFeatureMappings=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Use Case Requirements - - :param client: An authenticated API Client instance - :type client: ApiClient - :param datasetType: The project-specific enum value of the dataset type. - :type datasetType: str - :param name: The user-friendly name of the dataset type. - :type name: str - :param description: The description of the dataset type. - :type description: str - :param required: True if the dataset type is required for this project. - :type required: bool - :param multi: If true, multiple versions of the dataset type can be used for training. - :type multi: bool - :param allowedFeatureMappings: A collection of key-value pairs, with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { "description": str, "allowed_feature_types": feature_type_enum, "required": bool }. - :type allowedFeatureMappings: dict - :param allowedNestedFeatureMappings: A collection of key-value pairs, with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { "description": str, "allowed_feature_types": feature_type_enum, "required": bool }. - :type allowedNestedFeatureMappings: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: User(client, name=None, email=None, createdAt=None, status=None, organizationGroups={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Abacus.AI User - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The User's name. - :type name: str - :param email: The User's primary email address. - :type email: str - :param createdAt: The date and time when the user joined Abacus.AI. - :type createdAt: str - :param status: `ACTIVE` when the user has accepted an invite to join the organization, else `INVITED`. - :type status: str - :param organizationGroups: List of Organization Groups this user belongs to. - :type organizationGroups: OrganizationGroup - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: WebSearchResponse(client, searchResults={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Result of running a web search with optional content fetching. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param searchResults: List of search results. - :type searchResults: WebSearchResult - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Webhook(client, webhookId=None, deploymentId=None, endpoint=None, webhookEventType=None, payloadTemplate=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Abacus.AI Webhook attached to an endpoint and event trigger for a given object. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param webhookId: Unique identifier for this webhook. - :type webhookId: str - :param deploymentId: Identifier for the deployment this webhook is attached to. - :type deploymentId: str - :param endpoint: The URI this webhook will send HTTP POST requests to. - :type endpoint: str - :param webhookEventType: The event that triggers the webhook action. - :type webhookEventType: str - :param payloadTemplate: Template for JSON Dictionary to be sent as the body of the POST request. - :type payloadTemplate: str - :param createdAt: The date and time this webhook was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: Webhook - - - - .. py:method:: describe() - - Describe the webhook with a given ID. +Module Contents +--------------- - :param webhook_id: Unique string identifier of the target webhook. - :type webhook_id: str +Classes +~~~~~~~ - :returns: The webhook with the given ID. - :rtype: Webhook +.. autoapisummary:: + abacusai.client.AgentResponse + abacusai.client.ClientOptions + abacusai.client._ApiExceptionFactory + abacusai.client.BaseApiClient + abacusai.client.ReadOnlyClient + abacusai.client.ApiClient - .. py:method:: update(endpoint = None, webhook_event_type = None, payload_template = None) - Update the webhook +Functions +~~~~~~~~~ - :param endpoint: If provided, changes the webhook's endpoint. - :type endpoint: str - :param webhook_event_type: If provided, changes the event type. - :type webhook_event_type: str - :param payload_template: If provided, changes the payload template. - :type payload_template: dict +.. autoapisummary:: + abacusai.client._is_json_serializable + abacusai.client.sse_asynchronous_generator + abacusai.client._requests_retry_session + abacusai.client._discover_service_url + abacusai.client.get_source_code_info + abacusai.client.get_module_code_from_notebook + abacusai.client.include_modules - .. py:method:: delete() - Delete the webhook +Attributes +~~~~~~~~~~ - :param webhook_id: Unique identifier of the target webhook. - :type webhook_id: str +.. autoapisummary:: + abacusai.client.DEFAULT_SERVER + abacusai.client._request_context + abacusai.client._cached_endpoints .. py:data:: DEFAULT_SERVER :value: 'https://api.abacus.ai' + .. py:data:: _request_context + + .. py:function:: _is_json_serializable(object) Tests if an object is JSON serializable. @@ -13091,19 +72,23 @@ Module Contents .. py:function:: _requests_retry_session(retries=5, backoff_factor=0.1, status_forcelist=(502, 503, 504), session=None, retry_500 = False) + .. py:function:: _discover_service_url(service_discovery_url, client_version, deployment_id, deployment_token) + .. py:data:: _cached_endpoints -.. py:class:: Blob(contents, mime_type = None, filename = None) + .. py:class:: AgentResponse(*args, **kwargs) + Response object for agent to support attachments, section data and normal data .. py:class:: ClientOptions(exception_on_404 = True, server = DEFAULT_SERVER) + Options for configuring the ApiClient :param exception_on_404: If true, will raise an exception on a 404 from the server, else will return None. @@ -13114,8 +99,8 @@ Module Contents .. py:exception:: ApiException(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`Exception` + Bases: :py:obj:`Exception` Default ApiException raised by APIs @@ -13128,7 +113,6 @@ Module Contents :param request_id: The request id :type request_id: str - .. py:method:: __str__() Return str(self). @@ -13137,8 +121,8 @@ Module Contents .. py:exception:: MissingParameterError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Missing parameter error raised by APIs. This is usually raised when a required parameter is missing in the request. @@ -13154,8 +138,8 @@ Module Contents .. py:exception:: InvalidParameterError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Raised when an invalid parameter is provided. @@ -13171,8 +155,8 @@ Module Contents .. py:exception:: InvalidEnumParameterError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Raised when an invalid enumeration parameter is provided. @@ -13188,8 +172,8 @@ Module Contents .. py:exception:: PaymentMethodRequired(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Raised when a payment method is required. @@ -13205,8 +189,8 @@ Module Contents .. py:exception:: InvalidRequest(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Invalid request error raised by APIs. This is usually raised when the request is invalid or malformed. @@ -13222,8 +206,8 @@ Module Contents .. py:exception:: GenericPermissionDeniedError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Generic permission denied error raised by APIs. This is usually raised when permission is denied. @@ -13239,8 +223,8 @@ Module Contents .. py:exception:: PermissionDeniedError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Permission denied error raised by APIs. This is usually raised when a specific operation is not permitted. @@ -13256,8 +240,8 @@ Module Contents .. py:exception:: PaidPlanRequired(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Paid plan required error raised by APIs. This is usually raised when a paid plan is required for an operation. @@ -13273,8 +257,8 @@ Module Contents .. py:exception:: Generic404Error(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Generic 404 error raised by APIs. This is usually raised when a resource is not found. @@ -13290,8 +274,8 @@ Module Contents .. py:exception:: DataNotFoundError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Data not found error raised by APIs. This is usually raised when specific data is not found. @@ -13307,8 +291,8 @@ Module Contents .. py:exception:: MethodNotAllowed(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Method not allowed error raised by APIs. This is usually raised when a specific http method is not allowed for a resource. @@ -13324,8 +308,8 @@ Module Contents .. py:exception:: RequestTimeoutError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Exception raised when a timeout occurs during API request. @@ -13341,8 +325,8 @@ Module Contents .. py:exception:: ConflictError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Exception raised when a conflict occurs during API request. @@ -13358,8 +342,8 @@ Module Contents .. py:exception:: AlreadyExistsError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Exception raised when the entity being created already exists. @@ -13375,8 +359,8 @@ Module Contents .. py:exception:: NotReadyError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Not ready exception raised by APIs. This is usually raised when the operation requested is not ready. @@ -13392,8 +376,8 @@ Module Contents .. py:exception:: FailedDependencyError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Failed dependency exception raised by APIs. This is usually raised when the operation failed due to a dependency error. @@ -13409,8 +393,8 @@ Module Contents .. py:exception:: TooManyRequestsError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Too many requests exception raised by APIs. This is usually raised when the rate limit for requests has been exceeded. @@ -13426,8 +410,8 @@ Module Contents .. py:exception:: InstanceNotModifiedError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` InstanceNotModifiedError exception raised by APIs. This is usually raised when an instance is not modified. @@ -13443,8 +427,8 @@ Module Contents .. py:exception:: GatewayTimeoutError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Gateway timeout error raised by APIs. This is usually raised when a request times out waiting for a response from the gateway. @@ -13461,8 +445,8 @@ Module Contents .. py:exception:: InternalServerError(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`ApiException` + Bases: :py:obj:`ApiException` Internal server error raised by APIs. This is usually raised when the server encounters an unexpected error while processing the request. @@ -13479,8 +463,8 @@ Module Contents .. py:class:: _ApiExceptionFactory - Factory class to build exceptions raised by APIs + Factory class to build exceptions raised by APIs .. py:method:: from_response(message, http_status, exception = None, request_id = None) @@ -13490,6 +474,7 @@ Module Contents .. py:class:: BaseApiClient(api_key = None, server = None, client_options = None, skip_version_check = False) + Abstract Base API Client :param api_key: The api key to use as authentication to the server @@ -13501,11 +486,10 @@ Module Contents :param skip_version_check: If true, will skip checking the server's current API version on initializing the client :type skip_version_check: bool - .. py:attribute:: client_version - :value: '1.3.2' - + :value: '1.3.3' + .. py:method:: _get_prediction_endpoint(deployment_id, deployment_token) @@ -13543,10 +527,11 @@ Module Contents .. py:method:: _upload_from_spark(upload, df) + .. py:class:: ReadOnlyClient(api_key = None, server = None, client_options = None, skip_version_check = False) - Bases: :py:obj:`BaseApiClient` + Bases: :py:obj:`BaseApiClient` Abacus.AI Read Only API Client. Only contains GET methods @@ -13559,7 +544,6 @@ Module Contents :param skip_version_check: If true, will skip checking the server's current API version on initializing the client :type skip_version_check: bool - .. py:method:: list_api_keys() Lists all of the user's API keys @@ -13568,7 +552,6 @@ Module Contents :rtype: list[ApiKey] - .. py:method:: list_organization_users() Retrieves a list of all users in the organization, including pending users who have been invited. @@ -13577,7 +560,6 @@ Module Contents :rtype: list[User] - .. py:method:: describe_user() Retrieve the current user's information, such as their name, email address, and admin status. @@ -13586,7 +568,6 @@ Module Contents :rtype: User - .. py:method:: list_organization_groups() Lists all Organizations Groups @@ -13595,7 +576,6 @@ Module Contents :rtype: list[OrganizationGroup] - .. py:method:: describe_organization_group(organization_group_id) Returns the specific organization group passed in by the user. @@ -13607,7 +587,6 @@ Module Contents :rtype: OrganizationGroup - .. py:method:: describe_webhook(webhook_id) Describe the webhook with a given ID. @@ -13619,7 +598,6 @@ Module Contents :rtype: Webhook - .. py:method:: list_deployment_webhooks(deployment_id) List all the webhooks attached to a given deployment. @@ -13631,7 +609,6 @@ Module Contents :rtype: list[Webhook] - .. py:method:: list_use_cases() Retrieves a list of all use cases with descriptions. Use the given mappings to specify a use case when needed. @@ -13640,7 +617,6 @@ Module Contents :rtype: list[UseCase] - .. py:method:: describe_problem_type(problem_type) Describes a problem type @@ -13652,7 +628,6 @@ Module Contents :rtype: ProblemType - .. py:method:: describe_use_case_requirements(use_case) This API call returns the feature requirements for a specified use case. @@ -13664,7 +639,6 @@ Module Contents :rtype: list[UseCaseRequirements] - .. py:method:: describe_project(project_id) Returns a description of a project. @@ -13676,7 +650,6 @@ Module Contents :rtype: Project - .. py:method:: list_projects(limit = 100, start_after_id = None) Retrieves a list of all projects in the current organization. @@ -13690,7 +663,6 @@ Module Contents :rtype: list[Project] - .. py:method:: get_project_feature_group_config(feature_group_id, project_id) Gets a feature group's project config @@ -13704,7 +676,6 @@ Module Contents :rtype: ProjectConfig - .. py:method:: validate_project(project_id, feature_group_ids = None) Validates that the specified project has all required feature group types for its use case and that all required feature columns are set. @@ -13718,7 +689,6 @@ Module Contents :rtype: ProjectValidation - .. py:method:: infer_feature_mappings(project_id, feature_group_id) Infer the feature mappings for the feature group in the project based on the problem type. @@ -13732,7 +702,6 @@ Module Contents :rtype: InferredFeatureMappings - .. py:method:: verify_and_describe_annotation(feature_group_id, feature_name = None, doc_id = None, feature_group_row_identifier = None) Get the latest annotation entry for a given feature group, feature, and document along with verification information. @@ -13750,7 +719,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: get_annotations_status(feature_group_id, feature_name = None, check_for_materialization = False) Get the status of the annotations for a given feature group and feature. @@ -13766,7 +734,6 @@ Module Contents :rtype: AnnotationsStatus - .. py:method:: get_feature_group_schema(feature_group_id, project_id = None) Returns a schema for a given FeatureGroup in a project. @@ -13780,7 +747,6 @@ Module Contents :rtype: list[Feature] - .. py:method:: get_point_in_time_feature_group_creation_options() Returns the options that can be used to generate PIT features. @@ -13789,7 +755,6 @@ Module Contents :rtype: list[GeneratedPitFeatureConfigOption] - .. py:method:: describe_feature_group(feature_group_id) Describe a Feature Group. @@ -13801,7 +766,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: describe_feature_group_by_table_name(table_name) Describe a Feature Group by its table name. @@ -13813,7 +777,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: list_feature_groups(limit = 100, start_after_id = None, feature_group_template_id = None, is_including_detached_from_template = False) List all the feature groups @@ -13831,7 +794,6 @@ Module Contents :rtype: list[FeatureGroup] - .. py:method:: describe_project_feature_group(project_id, feature_group_id) Describe a feature group associated with a project @@ -13845,7 +807,6 @@ Module Contents :rtype: ProjectFeatureGroup - .. py:method:: list_project_feature_groups(project_id, filter_feature_group_use = None, limit = 100, start_after_id = None) List all the feature groups associated with a project @@ -13863,7 +824,6 @@ Module Contents :rtype: list[ProjectFeatureGroup] - .. py:method:: list_python_function_feature_groups(name, limit = 100) List all the feature groups associated with a python function. @@ -13877,7 +837,6 @@ Module Contents :rtype: list[FeatureGroup] - .. py:method:: get_execute_feature_group_operation_result_part_count(feature_group_operation_run_id) Gets the number of parts in the result of the execution of fg operation @@ -13886,7 +845,6 @@ Module Contents :type feature_group_operation_run_id: str - .. py:method:: download_execute_feature_group_operation_result_part_chunk(feature_group_operation_run_id, part, offset = 0, chunk_size = 10485760) Downloads a chunk of the result of the execution of feature group operation @@ -13901,7 +859,6 @@ Module Contents :type chunk_size: int - .. py:method:: get_feature_group_version_export_download_url(feature_group_export_id) Get a link to download the feature group version. @@ -13913,7 +870,6 @@ Module Contents :rtype: FeatureGroupExportDownloadUrl - .. py:method:: describe_feature_group_export(feature_group_export_id) A feature group export @@ -13925,7 +881,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: list_feature_group_exports(feature_group_id) Lists all of the feature group exports for the feature group @@ -13937,7 +892,6 @@ Module Contents :rtype: list[FeatureGroupExport] - .. py:method:: get_feature_group_export_connector_errors(feature_group_export_id) Returns a stream containing the write errors of the feature group export database connection, if any writes failed to the database connector. @@ -13946,7 +900,6 @@ Module Contents :type feature_group_export_id: str - .. py:method:: list_feature_group_modifiers(feature_group_id) List the users who can modify a given feature group. @@ -13958,7 +911,6 @@ Module Contents :rtype: ModificationLockInfo - .. py:method:: get_materialization_logs(feature_group_version, stdout = False, stderr = False) Returns logs for a materialized feature group version. @@ -13974,7 +926,6 @@ Module Contents :rtype: FunctionLogs - .. py:method:: list_feature_group_versions(feature_group_id, limit = 100, start_after_version = None) Retrieves a list of all feature group versions for the specified feature group. @@ -13990,7 +941,6 @@ Module Contents :rtype: list[FeatureGroupVersion] - .. py:method:: describe_feature_group_version(feature_group_version) Describe a feature group version. @@ -14002,7 +952,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: get_feature_group_version_metrics(feature_group_version, selected_columns = None, include_charts = False, include_statistics = True) Get metrics for a specific feature group version. @@ -14020,7 +969,6 @@ Module Contents :rtype: DataMetrics - .. py:method:: get_feature_group_version_logs(feature_group_version) Retrieves the feature group materialization logs. @@ -14032,7 +980,6 @@ Module Contents :rtype: FeatureGroupVersionLogs - .. py:method:: describe_feature_group_template(feature_group_template_id) Describe a Feature Group Template. @@ -14044,7 +991,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: list_feature_group_templates(limit = 100, start_after_id = None, feature_group_id = None, should_include_system_templates = False) List feature group templates, optionally scoped by the feature group that created the templates. @@ -14062,7 +1008,6 @@ Module Contents :rtype: list[FeatureGroupTemplate] - .. py:method:: list_project_feature_group_templates(project_id, limit = 100, start_after_id = None, should_include_all_system_templates = False) List feature group templates for feature groups associated with the project. @@ -14080,7 +1025,6 @@ Module Contents :rtype: list[FeatureGroupTemplate] - .. py:method:: suggest_feature_group_template_for_feature_group(feature_group_id) Suggest values for a feature gruop template, based on a feature group. @@ -14092,7 +1036,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: get_dataset_schema(dataset_id) Retrieves the column schema of a dataset. @@ -14104,7 +1047,6 @@ Module Contents :rtype: list[DatasetColumn] - .. py:method:: set_dataset_database_connector_config(dataset_id, database_connector_id, object_name = None, columns = None, query_arguments = None, sql_query = None) Sets database connector config for a dataset. This method is currently only supported for streaming datasets. @@ -14123,7 +1065,6 @@ Module Contents :type sql_query: str - .. py:method:: get_dataset_version_metrics(dataset_version, selected_columns = None, include_charts = False, include_statistics = True) Get metrics for a specific dataset version. @@ -14141,7 +1082,6 @@ Module Contents :rtype: DataMetrics - .. py:method:: get_file_connector_instructions(bucket, write_permission = False) Retrieves verification information to create a data connector to a cloud storage bucket. @@ -14155,7 +1095,6 @@ Module Contents :rtype: FileConnectorInstructions - .. py:method:: list_database_connectors() Retrieves a list of all database connectors along with their associated attributes. @@ -14164,7 +1103,6 @@ Module Contents :rtype: list[DatabaseConnector] - .. py:method:: list_file_connectors() Retrieves a list of all connected services in the organization and their current verification status. @@ -14173,7 +1111,6 @@ Module Contents :rtype: list[FileConnector] - .. py:method:: list_database_connector_objects(database_connector_id, fetch_raw_data = False) Lists querable objects in the database connector. @@ -14184,7 +1121,6 @@ Module Contents :type fetch_raw_data: bool - .. py:method:: get_database_connector_object_schema(database_connector_id, object_name = None, fetch_raw_data = False) Get the schema of an object in an database connector. @@ -14200,7 +1136,6 @@ Module Contents :rtype: DatabaseConnectorSchema - .. py:method:: query_database_connector(database_connector_id, query) Runs a query in the specified database connector. @@ -14211,7 +1146,6 @@ Module Contents :type query: str - .. py:method:: list_application_connectors() Retrieves a list of all application connectors along with their associated attributes. @@ -14220,7 +1154,6 @@ Module Contents :rtype: list[ApplicationConnector] - .. py:method:: list_application_connector_objects(application_connector_id) Lists querable objects in the application connector. @@ -14229,7 +1162,6 @@ Module Contents :type application_connector_id: str - .. py:method:: list_streaming_connectors() Retrieves a list of all streaming connectors along with their corresponding attributes. @@ -14238,7 +1170,6 @@ Module Contents :rtype: list[StreamingConnector] - .. py:method:: list_streaming_tokens() Retrieves a list of all streaming tokens. @@ -14247,7 +1178,6 @@ Module Contents :rtype: list[StreamingAuthToken] - .. py:method:: get_recent_feature_group_streamed_data(feature_group_id) Returns recently streamed data to a streaming feature group. @@ -14256,7 +1186,6 @@ Module Contents :type feature_group_id: str - .. py:method:: list_uploads() Lists all pending uploads @@ -14265,7 +1194,6 @@ Module Contents :rtype: list[Upload] - .. py:method:: describe_upload(upload_id) Retrieves the current upload status (complete or inspecting) and the list of file parts uploaded for a specified dataset upload. @@ -14277,7 +1205,6 @@ Module Contents :rtype: Upload - .. py:method:: list_datasets(limit = 100, start_after_id = None, exclude_streaming = False) Retrieves a list of all datasets in the organization. @@ -14293,7 +1220,6 @@ Module Contents :rtype: list[Dataset] - .. py:method:: describe_dataset(dataset_id) Retrieves a full description of the specified dataset, with attributes such as its ID, name, source type, etc. @@ -14305,7 +1231,6 @@ Module Contents :rtype: Dataset - .. py:method:: describe_dataset_version(dataset_version) Retrieves a full description of the specified dataset version, including its ID, name, source type, and other attributes. @@ -14317,7 +1242,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: list_dataset_versions(dataset_id, limit = 100, start_after_version = None) Retrieves a list of all dataset versions for the specified dataset. @@ -14333,7 +1257,6 @@ Module Contents :rtype: list[DatasetVersion] - .. py:method:: get_dataset_version_logs(dataset_version) Retrieves the dataset import logs. @@ -14345,7 +1268,6 @@ Module Contents :rtype: DatasetVersionLogs - .. py:method:: get_docstore_document(doc_id) Return a document store document by id. @@ -14354,7 +1276,6 @@ Module Contents :type doc_id: str - .. py:method:: get_docstore_image(doc_id, max_width = None, max_height = None) Return a document store image by id. @@ -14367,7 +1288,6 @@ Module Contents :type max_height: int - .. py:method:: describe_train_test_data_split_feature_group(model_id) Get the train and test data split for a trained model by its unique identifier. This is only supported for models with custom algorithms. @@ -14379,7 +1299,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: describe_train_test_data_split_feature_group_version(model_version) Get the train and test data split for a trained model by model version. This is only supported for models with custom algorithms. @@ -14391,7 +1310,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: list_models(project_id) Retrieves the list of models in the specified project. @@ -14403,7 +1321,6 @@ Module Contents :rtype: list[Model] - .. py:method:: describe_model(model_id) Retrieves a full description of the specified model. @@ -14415,7 +1332,6 @@ Module Contents :rtype: Model - .. py:method:: get_model_metrics(model_id, model_version = None, return_graphs = False, validation = False) Retrieves metrics for all the algorithms trained in this model version. @@ -14436,7 +1352,6 @@ Module Contents :rtype: ModelMetrics - .. py:method:: get_feature_group_schemas_for_model_version(model_version) Gets the schema (including feature mappings) for all feature groups used in the model version. @@ -14448,7 +1363,6 @@ Module Contents :rtype: list[ModelVersionFeatureGroupSchema] - .. py:method:: list_model_versions(model_id, limit = 100, start_after_version = None) Retrieves a list of versions for a given model. @@ -14464,7 +1378,6 @@ Module Contents :rtype: list[ModelVersion] - .. py:method:: describe_model_version(model_version) Retrieves a full description of the specified model version. @@ -14476,7 +1389,6 @@ Module Contents :rtype: ModelVersion - .. py:method:: get_feature_importance_by_model_version(model_version) Gets the feature importance calculated by various methods for the model. @@ -14488,7 +1400,6 @@ Module Contents :rtype: FeatureImportance - .. py:method:: get_training_data_logs(model_version) Retrieves the data preparation logs during model training. @@ -14500,7 +1411,6 @@ Module Contents :rtype: list[DataPrepLogs] - .. py:method:: get_training_logs(model_version, stdout = False, stderr = False) Returns training logs for the model. @@ -14516,7 +1426,6 @@ Module Contents :rtype: FunctionLogs - .. py:method:: describe_model_artifacts_export(model_artifacts_export_id) Get the description and status of the model artifacts export. @@ -14528,7 +1437,6 @@ Module Contents :rtype: ModelArtifactsExport - .. py:method:: list_model_artifacts_exports(model_id, limit = 25) List all the model artifacts exports. @@ -14542,7 +1450,6 @@ Module Contents :rtype: list[ModelArtifactsExport] - .. py:method:: list_model_monitors(project_id) Retrieves the list of model monitors in the specified project. @@ -14554,7 +1461,6 @@ Module Contents :rtype: list[ModelMonitor] - .. py:method:: describe_model_monitor(model_monitor_id) Retrieves a full description of the specified model monitor. @@ -14566,7 +1472,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: get_prediction_drift(model_monitor_version) Gets the label and prediction drifts for a model monitor. @@ -14578,7 +1483,6 @@ Module Contents :rtype: DriftDistributions - .. py:method:: get_model_monitor_summary(model_monitor_id) Gets the summary of a model monitor across versions. @@ -14590,7 +1494,6 @@ Module Contents :rtype: ModelMonitorSummary - .. py:method:: list_model_monitor_versions(model_monitor_id, limit = 100, start_after_version = None) Retrieves a list of versions for a given model monitor. @@ -14606,7 +1509,6 @@ Module Contents :rtype: list[ModelMonitorVersion] - .. py:method:: describe_model_monitor_version(model_monitor_version) Retrieves a full description of the specified model monitor version. @@ -14618,7 +1520,6 @@ Module Contents :rtype: ModelMonitorVersion - .. py:method:: model_monitor_version_metric_data(model_monitor_version, metric_type, actual_values_to_detail = None) Provides the data needed for decile metrics associated with the model monitor. @@ -14634,7 +1535,6 @@ Module Contents :rtype: ModelMonitorVersionMetricData - .. py:method:: list_organization_model_monitors(only_starred = False) Gets a list of Model Monitors for an organization. @@ -14646,7 +1546,6 @@ Module Contents :rtype: list[ModelMonitor] - .. py:method:: get_model_monitor_chart_from_organization(chart_type, limit = 15) Gets a list of model monitor summaries across monitors for an organization. @@ -14660,7 +1559,6 @@ Module Contents :rtype: list[ModelMonitorSummaryFromOrg] - .. py:method:: get_model_monitor_summary_from_organization() Gets a consolidated summary of model monitors for an organization. @@ -14669,7 +1567,6 @@ Module Contents :rtype: list[ModelMonitorOrgSummary] - .. py:method:: list_eda(project_id) Retrieves the list of Exploratory Data Analysis (EDA) in the specified project. @@ -14681,7 +1578,6 @@ Module Contents :rtype: list[Eda] - .. py:method:: describe_eda(eda_id) Retrieves a full description of the specified EDA object. @@ -14693,7 +1589,6 @@ Module Contents :rtype: Eda - .. py:method:: list_eda_versions(eda_id, limit = 100, start_after_version = None) Retrieves a list of versions for a given EDA object. @@ -14709,7 +1604,6 @@ Module Contents :rtype: list[EdaVersion] - .. py:method:: describe_eda_version(eda_version) Retrieves a full description of the specified EDA version. @@ -14721,7 +1615,6 @@ Module Contents :rtype: EdaVersion - .. py:method:: get_eda_collinearity(eda_version) Gets the Collinearity between all features for the Exploratory Data Analysis. @@ -14733,7 +1626,6 @@ Module Contents :rtype: EdaCollinearity - .. py:method:: get_eda_data_consistency(eda_version, transformation_feature = None) Gets the data consistency for the Exploratory Data Analysis. @@ -14747,7 +1639,6 @@ Module Contents :rtype: EdaDataConsistency - .. py:method:: get_collinearity_for_feature(eda_version, feature_name = None) Gets the Collinearity for the given feature from the Exploratory Data Analysis. @@ -14761,7 +1652,6 @@ Module Contents :rtype: EdaFeatureCollinearity - .. py:method:: get_feature_association(eda_version, reference_feature_name, test_feature_name) Gets the Feature Association for the given features from the feature group version within the eda_version. @@ -14777,7 +1667,6 @@ Module Contents :rtype: EdaFeatureAssociation - .. py:method:: get_eda_forecasting_analysis(eda_version) Gets the Forecasting analysis for the Exploratory Data Analysis. @@ -14789,7 +1678,6 @@ Module Contents :rtype: EdaForecastingAnalysis - .. py:method:: list_holdout_analysis(project_id, model_id = None) List holdout analyses for a project. Optionally, filter by model. @@ -14803,7 +1691,6 @@ Module Contents :rtype: list[HoldoutAnalysis] - .. py:method:: describe_holdout_analysis(holdout_analysis_id) Get a holdout analysis. @@ -14815,7 +1702,6 @@ Module Contents :rtype: HoldoutAnalysis - .. py:method:: list_holdout_analysis_versions(holdout_analysis_id) List holdout analysis versions for a holdout analysis. @@ -14827,7 +1713,6 @@ Module Contents :rtype: list[HoldoutAnalysisVersion] - .. py:method:: describe_holdout_analysis_version(holdout_analysis_version, get_metrics = False) Get a holdout analysis version. @@ -14841,7 +1726,6 @@ Module Contents :rtype: HoldoutAnalysisVersion - .. py:method:: describe_monitor_alert(monitor_alert_id) Describes a given monitor alert id @@ -14853,7 +1737,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: describe_monitor_alert_version(monitor_alert_version) Describes a given monitor alert version id @@ -14865,7 +1748,6 @@ Module Contents :rtype: MonitorAlertVersion - .. py:method:: list_monitor_alerts_for_monitor(model_monitor_id = None, realtime_monitor_id = None) Retrieves the list of monitor alerts for a specified monitor. One of the model_monitor_id or realtime_monitor_id is required but not both. @@ -14879,7 +1761,6 @@ Module Contents :rtype: list[MonitorAlert] - .. py:method:: list_monitor_alert_versions_for_monitor_version(model_monitor_version) Retrieves the list of monitor alert versions for a specified monitor instance. @@ -14891,7 +1772,6 @@ Module Contents :rtype: list[MonitorAlertVersion] - .. py:method:: get_drift_for_feature(model_monitor_version, feature_name, nested_feature_name = None) Gets the feature drift associated with a single feature in an output feature group from a prediction. @@ -14907,7 +1787,6 @@ Module Contents :rtype: FeatureDistribution - .. py:method:: get_outliers_for_feature(model_monitor_version, feature_name = None, nested_feature_name = None) Gets a list of outliers measured by a single feature (or overall) in an output feature group from a prediction. @@ -14920,7 +1799,6 @@ Module Contents :type nested_feature_name: str - .. py:method:: describe_prediction_operator(prediction_operator_id) Describe an existing prediction operator. @@ -14932,7 +1810,6 @@ Module Contents :rtype: PredictionOperator - .. py:method:: list_prediction_operators(project_id) List all the prediction operators inside a project. @@ -14944,7 +1821,6 @@ Module Contents :rtype: list[PredictionOperator] - .. py:method:: list_prediction_operator_versions(prediction_operator_id) List all the prediction operator versions for a prediction operator. @@ -14956,7 +1832,6 @@ Module Contents :rtype: list[PredictionOperatorVersion] - .. py:method:: describe_deployment(deployment_id) Retrieves a full description of the specified deployment. @@ -14968,7 +1843,6 @@ Module Contents :rtype: Deployment - .. py:method:: list_deployments(project_id) Retrieves a list of all deployments in the specified project. @@ -14980,7 +1854,6 @@ Module Contents :rtype: list[Deployment] - .. py:method:: list_deployment_tokens(project_id) Retrieves a list of all deployment tokens associated with the specified project. @@ -14992,7 +1865,6 @@ Module Contents :rtype: list[DeploymentAuthToken] - .. py:method:: get_api_endpoint(deployment_token = None, deployment_id = None, streaming_token = None, feature_group_id = None, model_id = None) Returns the API endpoint specific to an organization. This function can be utilized using either an API Key or a deployment ID and token for authentication. @@ -15012,7 +1884,6 @@ Module Contents :rtype: ApiEndpoint - .. py:method:: get_model_training_types_for_deployment(model_id, model_version = None, algorithm = None) Returns types of models that can be deployed for a given model instance ID. @@ -15028,7 +1899,6 @@ Module Contents :rtype: ModelTrainingTypeForDeployment - .. py:method:: list_deployment_alerts(deployment_id) List the monitor alerts associated with the deployment id. @@ -15040,7 +1910,6 @@ Module Contents :rtype: list[MonitorAlert] - .. py:method:: list_realtime_monitors(project_id) List the real-time monitors associated with the deployment id. @@ -15052,7 +1921,6 @@ Module Contents :rtype: list[RealtimeMonitor] - .. py:method:: describe_realtime_monitor(realtime_monitor_id) Get the real-time monitor associated with the real-time monitor id. @@ -15064,7 +1932,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: describe_refresh_policy(refresh_policy_id) Retrieve a single refresh policy @@ -15076,7 +1943,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: describe_refresh_pipeline_run(refresh_pipeline_run_id) Retrieve a single refresh pipeline run @@ -15088,7 +1954,6 @@ Module Contents :rtype: RefreshPipelineRun - .. py:method:: list_refresh_policies(project_id = None, dataset_ids = [], feature_group_id = None, model_ids = [], deployment_ids = [], batch_prediction_ids = [], model_monitor_ids = [], notebook_ids = []) List the refresh policies for the organization. If no filters are specified, all refresh policies are returned. @@ -15114,7 +1979,6 @@ Module Contents :rtype: list[RefreshPolicy] - .. py:method:: list_refresh_pipeline_runs(refresh_policy_id) List the the times that the refresh policy has been run @@ -15126,7 +1990,6 @@ Module Contents :rtype: list[RefreshPipelineRun] - .. py:method:: download_batch_prediction_result_chunk(batch_prediction_version, offset = 0, chunk_size = 10485760) Returns a stream containing the batch prediction results. @@ -15139,7 +2002,6 @@ Module Contents :type chunk_size: int - .. py:method:: get_batch_prediction_connector_errors(batch_prediction_version) Returns a stream containing the batch prediction database connection write errors, if any writes failed for the specified batch prediction job. @@ -15148,7 +2010,6 @@ Module Contents :type batch_prediction_version: str - .. py:method:: list_batch_predictions(project_id) Retrieves a list of batch predictions in the project. @@ -15160,7 +2021,6 @@ Module Contents :rtype: list[BatchPrediction] - .. py:method:: describe_batch_prediction(batch_prediction_id) Describe the batch prediction. @@ -15172,7 +2032,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: list_batch_prediction_versions(batch_prediction_id, limit = 100, start_after_version = None) Retrieves a list of versions of a given batch prediction @@ -15188,7 +2047,6 @@ Module Contents :rtype: list[BatchPredictionVersion] - .. py:method:: describe_batch_prediction_version(batch_prediction_version) Describes a Batch Prediction Version. @@ -15200,7 +2058,6 @@ Module Contents :rtype: BatchPredictionVersion - .. py:method:: get_batch_prediction_version_logs(batch_prediction_version) Retrieves the batch prediction logs. @@ -15212,7 +2069,6 @@ Module Contents :rtype: BatchPredictionVersionLogs - .. py:method:: get_data(feature_group_id, primary_key = None, num_rows = None) Gets the feature group rows for online updatable feature groups. @@ -15232,7 +2088,6 @@ Module Contents :rtype: list[FeatureGroupRow] - .. py:method:: describe_python_function(name) Describe a Python Function. @@ -15244,7 +2099,6 @@ Module Contents :rtype: PythonFunction - .. py:method:: list_python_functions(function_type = 'FEATURE_GROUP') List all python functions within the organization. @@ -15256,7 +2110,6 @@ Module Contents :rtype: list[PythonFunction] - .. py:method:: list_pipelines(project_id = None) Lists the pipelines for an organization or a project @@ -15268,7 +2121,6 @@ Module Contents :rtype: list[Pipeline] - .. py:method:: describe_pipeline_version(pipeline_version) Describes a specified pipeline version @@ -15280,7 +2132,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: describe_pipeline_step(pipeline_step_id) Deletes a step from a pipeline. @@ -15292,7 +2143,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: describe_pipeline_step_by_name(pipeline_id, step_name) Describes a pipeline step by the step name. @@ -15306,7 +2156,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: describe_pipeline_step_version(pipeline_step_version) Describes a pipeline step version. @@ -15318,7 +2167,6 @@ Module Contents :rtype: PipelineStepVersion - .. py:method:: list_pipeline_version_logs(pipeline_version) Gets the logs for the steps in a given pipeline version. @@ -15330,7 +2178,6 @@ Module Contents :rtype: PipelineVersionLogs - .. py:method:: get_step_version_logs(pipeline_step_version) Gets the logs for a given step version. @@ -15342,7 +2189,6 @@ Module Contents :rtype: PipelineStepVersionLogs - .. py:method:: describe_graph_dashboard(graph_dashboard_id) Describes a given graph dashboard. @@ -15354,7 +2200,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: list_graph_dashboards(project_id = None) Lists the graph dashboards for a project @@ -15366,7 +2211,6 @@ Module Contents :rtype: list[GraphDashboard] - .. py:method:: describe_graph_for_dashboard(graph_reference_id) Describes a python plot to a graph dashboard @@ -15378,7 +2222,6 @@ Module Contents :rtype: PythonPlotFunction - .. py:method:: describe_algorithm(algorithm) Retrieves a full description of the specified algorithm. @@ -15390,7 +2233,6 @@ Module Contents :rtype: Algorithm - .. py:method:: list_algorithms(problem_type = None, project_id = None) List all custom algorithms, with optional filtering on Problem Type and Project ID @@ -15404,7 +2246,6 @@ Module Contents :rtype: list[Algorithm] - .. py:method:: describe_custom_loss_function(name) Retrieve a full description of a previously registered custom loss function. @@ -15416,7 +2257,6 @@ Module Contents :rtype: CustomLossFunction - .. py:method:: list_custom_loss_functions(name_prefix = None, loss_function_type = None) Retrieves a list of registered custom loss functions and their descriptions. @@ -15430,7 +2270,6 @@ Module Contents :rtype: CustomLossFunction - .. py:method:: describe_custom_metric(name) Retrieves a full description of a previously registered custom metric function. @@ -15442,7 +2281,6 @@ Module Contents :rtype: CustomMetric - .. py:method:: describe_custom_metric_version(custom_metric_version) Describes a given custom metric version @@ -15454,7 +2292,6 @@ Module Contents :rtype: CustomMetricVersion - .. py:method:: list_custom_metrics(name_prefix = None, problem_type = None) Retrieves a list of registered custom metrics. @@ -15468,7 +2305,6 @@ Module Contents :rtype: list[CustomMetric] - .. py:method:: describe_module(name) Retrieves a full description of the specified module. @@ -15480,7 +2316,6 @@ Module Contents :rtype: Module - .. py:method:: list_modules() List all the modules @@ -15489,7 +2324,6 @@ Module Contents :rtype: list[Module] - .. py:method:: get_organization_secret(secret_key) Gets a secret. @@ -15501,7 +2335,6 @@ Module Contents :rtype: OrganizationSecret - .. py:method:: list_organization_secrets() Lists all secrets for an organization. @@ -15510,7 +2343,6 @@ Module Contents :rtype: list[OrganizationSecret] - .. py:method:: query_feature_group_code_generator(query, language, project_id = None) Send a query to the feature group code generator tool to generate code for the query. @@ -15526,7 +2358,6 @@ Module Contents :rtype: LlmResponse - .. py:method:: get_natural_language_explanation(feature_group_id = None, feature_group_version = None, model_id = None) Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model @@ -15542,7 +2373,6 @@ Module Contents :rtype: NaturalLanguageExplanation - .. py:method:: generate_natural_language_explanation(feature_group_id = None, feature_group_version = None, model_id = None) Generates natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model @@ -15558,7 +2388,6 @@ Module Contents :rtype: NaturalLanguageExplanation - .. py:method:: get_chat_session(chat_session_id) Gets a chat session from Data Science Co-pilot. @@ -15570,7 +2399,6 @@ Module Contents :rtype: ChatSession - .. py:method:: list_chat_sessions(most_recent_per_project = False) Lists all chat sessions for the current user @@ -15582,8 +2410,7 @@ Module Contents :rtype: ChatSession - - .. py:method:: get_deployment_conversation(deployment_conversation_id = None, external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True) + .. py:method:: get_deployment_conversation(deployment_conversation_id = None, external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True, get_unused_document_uploads = False) Gets a deployment conversation. @@ -15597,12 +2424,13 @@ Module Contents :type deployment_token: str :param filter_intermediate_conversation_events: If true, intermediate conversation events will be filtered out. Default is true. :type filter_intermediate_conversation_events: bool + :param get_unused_document_uploads: If true, unused document uploads will be returned. Default is false. + :type get_unused_document_uploads: bool :returns: The deployment conversation. :rtype: DeploymentConversation - .. py:method:: list_deployment_conversations(deployment_id, external_application_id = None) Lists all conversations for the given deployment and current user. @@ -15616,7 +2444,6 @@ Module Contents :rtype: list[DeploymentConversation] - .. py:method:: export_deployment_conversation(deployment_conversation_id = None, external_session_id = None) Export a Deployment Conversation. @@ -15630,7 +2457,6 @@ Module Contents :rtype: DeploymentConversationExport - .. py:method:: get_app_user_group(user_group_id) Gets an App User Group. @@ -15642,7 +2468,6 @@ Module Contents :rtype: AppUserGroup - .. py:method:: describe_external_application(external_application_id) Describes an External Application. @@ -15654,7 +2479,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: list_external_applications() Lists External Applications in an organization. @@ -15663,7 +2487,6 @@ Module Contents :rtype: list[ExternalApplication] - .. py:method:: download_agent_attachment(deployment_id, attachment_id) Return an agent attachment. @@ -15674,7 +2497,6 @@ Module Contents :type attachment_id: str - .. py:method:: describe_agent(agent_id) Retrieves a full description of the specified model. @@ -15686,7 +2508,6 @@ Module Contents :rtype: Agent - .. py:method:: describe_agent_version(agent_version) Retrieves a full description of the specified agent version. @@ -15698,7 +2519,6 @@ Module Contents :rtype: AgentVersion - .. py:method:: search_feature_groups(text, num_results = 10, project_id = None, feature_group_ids = None) Search feature groups based on text and filters. @@ -15716,7 +2536,6 @@ Module Contents :rtype: list[OrganizationSearchResult] - .. py:method:: list_agents(project_id) Retrieves the list of agents in the specified project. @@ -15728,7 +2547,6 @@ Module Contents :rtype: list[Agent] - .. py:method:: list_agent_versions(agent_id, limit = 100, start_after_version = None) List all versions of an agent. @@ -15744,7 +2562,6 @@ Module Contents :rtype: list[AgentVersion] - .. py:method:: list_llm_apps() Lists all available LLM Apps, which are LLMs tailored to achieve a specific task like code generation for a specific service's API. @@ -15753,7 +2570,6 @@ Module Contents :rtype: list[LlmApp] - .. py:method:: list_document_retrievers(project_id, limit = 100, start_after_id = None) List all the document retrievers. @@ -15769,7 +2585,6 @@ Module Contents :rtype: list[DocumentRetriever] - .. py:method:: describe_document_retriever(document_retriever_id) Describe a Document Retriever. @@ -15781,7 +2596,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: describe_document_retriever_by_name(name) Describe a document retriever by its name. @@ -15793,7 +2607,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: list_document_retriever_versions(document_retriever_id, limit = 100, start_after_version = None) List all the document retriever versions with a given ID. @@ -15809,7 +2622,6 @@ Module Contents :rtype: list[DocumentRetrieverVersion] - .. py:method:: describe_document_retriever_version(document_retriever_version) Describe a document retriever version. @@ -15824,14 +2636,17 @@ Module Contents .. py:function:: get_source_code_info(train_function, predict_function = None, predict_many_function = None, initialize_function = None, common_functions = None) + .. py:function:: get_module_code_from_notebook(file_path) + .. py:function:: include_modules(source_code, included_modules) + .. py:class:: ApiClient(api_key = None, server = None, client_options = None, skip_version_check = False) - Bases: :py:obj:`ReadOnlyClient` + Bases: :py:obj:`ReadOnlyClient` Abacus.AI API Client @@ -15844,7 +2659,6 @@ Module Contents :param skip_version_check: If true, will skip checking the server's current API version on initializing the client :type skip_version_check: bool - .. py:method:: create_dataset_from_pandas(feature_group_table_name, df, clean_column_names = False) [Deprecated] @@ -15861,7 +2675,6 @@ Module Contents :rtype: Dataset - .. py:method:: create_dataset_version_from_pandas(table_name_or_id, df, clean_column_names = False) [Deprecated] @@ -15878,7 +2691,6 @@ Module Contents :rtype: Dataset - .. py:method:: create_feature_group_from_pandas_df(table_name, df, clean_column_names = False) Create a Feature Group from a local Pandas DataFrame. @@ -15891,7 +2703,6 @@ Module Contents :type clean_column_names: bool - .. py:method:: update_feature_group_from_pandas_df(table_name, df, clean_column_names = False) Updates a DATASET Feature Group from a local Pandas DataFrame. @@ -15904,7 +2715,6 @@ Module Contents :type clean_column_names: bool - .. py:method:: create_feature_group_from_spark_df(table_name, df) Create a Feature Group from a local Spark DataFrame. @@ -15915,7 +2725,6 @@ Module Contents :type table_name: str - .. py:method:: update_feature_group_from_spark_df(table_name, df) Create a Feature Group from a local Spark DataFrame. @@ -15930,7 +2739,6 @@ Module Contents :type timeout: int - .. py:method:: create_spark_df_from_feature_group_version(session, feature_group_version) Create a Spark Dataframe in the provided Spark Session context, for a materialized Abacus Feature Group Version. @@ -15943,7 +2751,6 @@ Module Contents :returns: pyspark.sql.DataFrame - .. py:method:: create_prediction_operator_from_functions(name, project_id, predict_function = None, initialize_function = None, feature_group_ids = None, cpu_size = None, memory = None, included_modules = None, package_requirements = None, use_gpu = False) Create a new prediction operator. @@ -15973,7 +2780,6 @@ Module Contents PredictionOperator: The updated prediction operator object. - .. py:method:: update_prediction_operator_from_functions(prediction_operator_id, name = None, predict_function = None, initialize_function = None, feature_group_ids = None, cpu_size = None, memory = None, included_modules = None, package_requirements = None, use_gpu = False) Update an existing prediction operator. @@ -16000,7 +2806,6 @@ Module Contents :type use_gpu: bool - .. py:method:: create_model_from_functions(project_id, train_function, predict_function = None, training_input_tables = None, predict_many_function = None, initialize_function = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False, included_modules = None, package_requirements = None, name = None, use_gpu = False, is_thread_safe = None) Creates a model from a python function @@ -16037,7 +2842,6 @@ Module Contents :type is_thread_safe: bool - .. py:method:: update_model_from_functions(model_id, train_function, predict_function = None, predict_many_function = None, initialize_function = None, training_input_tables = None, cpu_size = None, memory = None, included_modules = None, package_requirements = None, use_gpu = False, is_thread_safe = None) Creates a model from a python function. Please pass in all the functions, even if you don't update it. @@ -16068,7 +2872,6 @@ Module Contents :type is_thread_safe: bool - .. py:method:: create_pipeline_step_from_function(pipeline_id, step_name, function, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, included_modules = None, timeout = None) Creates a step in a given pipeline from a python function. @@ -16097,7 +2900,6 @@ Module Contents :type timeout: int - .. py:method:: update_pipeline_step_from_function(pipeline_step_id, function, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, included_modules = None, timeout = None) Updates a pipeline step from a python function. @@ -16124,7 +2926,6 @@ Module Contents :type timeout: int - .. py:method:: create_python_function_from_function(name, function, function_variable_mappings = None, package_requirements = None, function_type = PythonFunctionType.FEATURE_GROUP.value) Creates a custom Python function @@ -16141,7 +2942,6 @@ Module Contents :type function_type: PythonFunctionType - .. py:method:: create_feature_group_from_python_function(function, table_name, input_tables = None, python_function_name = None, python_function_bindings = None, cpu_size = None, memory = None, package_requirements = None, included_modules = None) Creates a feature group from a python function @@ -16166,7 +2966,6 @@ Module Contents :type included_modules: list - .. py:method:: update_python_function_code(name, function = None, function_variable_mappings = None, package_requirements = None, included_modules = None) Update custom python function with user inputs for the given python function. @@ -16186,7 +2985,6 @@ Module Contents :rtype: PythonFunction - .. py:method:: create_algorithm_from_function(name, problem_type, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function = None, predict_function = None, predict_many_function = None, initialize_function = None, common_functions = None, config_options = None, is_default_enabled = False, project_id = None, use_gpu = False, package_requirements = None, included_modules = None) Create a new algorithm, or update existing algorithm if the name already exists @@ -16223,7 +3021,6 @@ Module Contents :type included_modules: list - .. py:method:: update_algorithm_from_function(algorithm, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function = None, predict_function = None, predict_many_function = None, initialize_function = None, common_functions = None, config_options = None, is_default_enabled = None, use_gpu = None, package_requirements = None, included_modules = None) Create a new algorithm, or update existing algorithm if the name already exists @@ -16256,7 +3053,6 @@ Module Contents :type included_modules: list - .. py:method:: get_train_function_input(project_id, training_table_names = None, training_data_parameter_name_override = None, training_config_parameter_name_override = None, training_config = None, custom_algorithm_config = None) Get the input data for the train function to test locally. @@ -16277,7 +3073,6 @@ Module Contents :returns: A dictionary that maps train function parameter names to their values. - .. py:method:: get_train_function_input_from_model_version(model_version, algorithm = None, training_config = None, custom_algorithm_config = None) Get the input data for the train function to test locally, based on a trained model version. @@ -16294,7 +3089,6 @@ Module Contents :returns: A dictionary that maps train function parameter names to their values. - .. py:method:: create_custom_loss_function(name, loss_function_type, loss_function) Registers a new custom loss function which can be used as an objective function during model training. @@ -16313,7 +3107,6 @@ Module Contents :raises AlreadyExistsError: If the loss function with the same name already exists in the organization - .. py:method:: update_custom_loss_function(name, loss_function) Updates a previously registered custom loss function with a new function implementation. @@ -16330,7 +3123,6 @@ Module Contents :raises DataNotFoundError: If a loss function with given name is not found in the organization - .. py:method:: create_custom_metric_from_function(name, problem_type, custom_metric_function) Registers a new custom metric which can be used as an evaluation metric for the trained model. @@ -16349,7 +3141,6 @@ Module Contents :raises AlreadyExistsError: If a custom metric with given name already exists in the organization. - .. py:method:: update_custom_metric_from_function(name, custom_metric_function) Updates a previously registered custom metric. @@ -16366,7 +3157,6 @@ Module Contents :raises DataNotFoundError: If a custom metric with given name is not found in the organization. - .. py:method:: create_module_from_notebook(file_path, name) Create a module with the code marked in the notebook. Use '#module_start#' to mark the starting code cell and '#module_end#' for the @@ -16381,7 +3171,6 @@ Module Contents :rtype: Module - .. py:method:: update_module_from_notebook(file_path, name) Update the module with the code marked in the notebook. Use '#module_start#' to mark the starting code cell and '#module_end#' for the @@ -16396,7 +3185,6 @@ Module Contents :rtype: Module - .. py:method:: import_module(name) Import a module created previously. It will reload if has been imported before. @@ -16409,7 +3197,6 @@ Module Contents :rtype: module - .. py:method:: create_agent_from_function(project_id, agent_function, name = None, memory = None, package_requirements = None, description = None, evaluation_feature_group_id = None, workflow_graph = None) [Deprecated] @@ -16433,7 +3220,6 @@ Module Contents :type workflow_graph: WorkflowGraph - .. py:method:: update_agent_with_function(model_id, agent_function, memory = None, package_requirements = None, enable_binary_input = None, description = None, workflow_graph = None) [Deprecated] @@ -16455,7 +3241,6 @@ Module Contents :type workflow_graph: WorkflowGraph - .. py:method:: execute_feature_group_sql(sql, fix_query_on_error = False, timeout=3600, delay=2) Execute a SQL query on the feature groups @@ -16469,14 +3254,13 @@ Module Contents :rtype: pandas.DataFrame - .. py:method:: get_agent_context_chat_history() Gets a history of chat messages from the current request context. Applicable within a AIAgent execute function. - :returns: List[ChatMessage]:: The chat history for the current request being processed by the Agent. - + :returns: The chat history for the current request being processed by the Agent. + :rtype: List[ChatMessage] .. py:method:: set_agent_context_chat_history(chat_history) @@ -16487,7 +3271,6 @@ Module Contents :type chat_history: List[ChatMessage] - .. py:method:: get_agent_context_conversation_id() Gets the deployment conversation ID from the current request context. Applicable within a AIAgent @@ -16497,7 +3280,6 @@ Module Contents :rtype: str - .. py:method:: set_agent_context_conversation_id(conversation_id) Sets the deployment conversation ID from the current request context. @@ -16506,7 +3288,6 @@ Module Contents :type conversation_id: str - .. py:method:: get_agent_context_external_session_id() Gets the external session ID from the current request context if it has been set with the request. @@ -16516,7 +3297,6 @@ Module Contents :rtype: str - .. py:method:: set_agent_context_external_session_id(external_session_id) Sets the external session ID from the current request context if it has been set with the request. @@ -16525,7 +3305,6 @@ Module Contents :type external_session_id: str - .. py:method:: get_agent_context_doc_ids() Gets the document ID from the current request context if a document has been uploaded with the request. @@ -16535,7 +3314,6 @@ Module Contents :rtype: List[str] - .. py:method:: set_agent_context_doc_ids(doc_ids) Sets the doc_ids from the current request context. @@ -16544,7 +3322,6 @@ Module Contents :type doc_ids: List[str] - .. py:method:: get_agent_context_doc_infos() Gets the document information from the current request context if documents have been uploaded with the request. @@ -16554,7 +3331,6 @@ Module Contents :rtype: List[dict] - .. py:method:: set_agent_context_doc_infos(doc_infos) Sets the doc_infos in the current request context. @@ -16563,7 +3339,6 @@ Module Contents :type doc_infos: List[dict] - .. py:method:: get_agent_context_blob_inputs() Gets the BlobInputs from the current request context if a document has been uploaded with the request. @@ -16573,13 +3348,11 @@ Module Contents :rtype: List[BlobInput] - .. py:method:: clear_agent_context() Clears the current request context. - .. py:method:: streaming_evaluate_prompt(prompt = None, system_message = None, llm_name = None, max_tokens = None, temperature = 0.0, messages = None, response_type = None, json_response_schema = None, section_key = None) Generate response to the prompt using the specified model. @@ -16605,8 +3378,7 @@ Module Contents :type section_key: str :returns: The response from the model. - :rtype: text - + :rtype: text (str) .. py:method:: _get_agent_app_request_id() @@ -16617,7 +3389,6 @@ Module Contents :rtype: str - .. py:method:: _get_agent_async_app_caller() Gets the caller for the current request context of async app. Applicable within a AIAgent execute function. @@ -16626,7 +3397,6 @@ Module Contents :rtype: str - .. py:method:: _is_proxy_app_caller() Gets the caller for the current request context of async app. Applicable within a AIAgent execute function. @@ -16635,7 +3405,6 @@ Module Contents :rtype: bool - .. py:method:: stream_message(message) Streams a message to the current request context. Applicable within a AIAgent execute function. @@ -16645,7 +3414,6 @@ Module Contents :type message: str - .. py:method:: stream_section_output(section_key, value, value_type = 'text') Streams value corresponding to a particular section to the current request context. Applicable within a AIAgent execute function. @@ -16659,7 +3427,6 @@ Module Contents :type value_type: str - .. py:method:: _stream_llm_call(section_key=None, **kwargs) @@ -16680,7 +3447,6 @@ Module Contents :rtype: str - .. py:method:: _status_poll(url, wait_states, method, body = {}, headers = None, delay = 2, timeout = 1200) @@ -16711,7 +3477,6 @@ Module Contents :rtype: LlmExecutionResult - .. py:method:: _get_doc_retriever_deployment_info(document_retriever_id) @@ -16755,7 +3520,6 @@ Module Contents :rtype: list[DocumentRetrieverLookupResult] - .. py:method:: create_model_from_files(project_id, location, name = None, custom_artifact_filenames = {}, model_config = {}) Creates a new Model and returns Upload IDs for uploading the model artifacts. @@ -16778,7 +3542,6 @@ Module Contents :rtype: Model - .. py:method:: create_model_from_local_files(project_id, name = None, optional_artifacts = None, model_config = {}) Creates a new Model and returns Upload IDs for uploading the model artifacts. @@ -16799,7 +3562,6 @@ Module Contents :rtype: ModelUpload - .. py:method:: create_model_version_from_files(model_id) Creates a new Model Version by re-importing from the paths specified when the model was created. @@ -16811,7 +3573,6 @@ Module Contents :rtype: ModelVersion - .. py:method:: create_model_version_from_local_files(model_id, optional_artifacts = None) Creates a new Model Version and returns Upload IDs for uploading the associated model artifacts. @@ -16825,7 +3586,6 @@ Module Contents :rtype: ModelUpload - .. py:method:: get_streaming_chat_response(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, include_search_results = False) Return an asynchronous generator which continues the conversation based on the input messages and search results. @@ -16856,7 +3616,6 @@ Module Contents :type include_search_results: bool - .. py:method:: get_streaming_conversation_response(deployment_token, deployment_id, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, include_search_results = False) Return an asynchronous generator which continues the conversation based on the input messages and search results. @@ -16891,7 +3650,6 @@ Module Contents :type include_search_results: bool - .. py:method:: set_cache_scope(scope) Set the scope of the cache, for example, deployment id. @@ -16902,13 +3660,11 @@ Module Contents :returns: None - .. py:method:: clear_cache_scope() Clear the scope set before, and let it to automatically figure out the scope to use. If nothing found, will run in local. - .. py:method:: set_scoped_cache_value(key, value, expiration_time = 21600) Set the value to key in the cache scope. Scope will be automatically figured out inside a deployment, or set with set_cache_scope. @@ -16926,7 +3682,6 @@ Module Contents :raises InvalidParameterError: If key, value or expiration_time is invalid. - .. py:method:: get_scoped_cache_value(key) Get the value of the key in the cache scope. Scope will be automatically figured out inside a deployment, or set with set_cache_scope. @@ -16941,7 +3696,6 @@ Module Contents :raises Generic404Error: if the key doesn't exist. - .. py:method:: delete_scoped_cache_key(key) Delete the value of the key in the cache scope. Scope will be automatically figured out inside a deployment, or set with set_cache_scope. @@ -16953,7 +3707,6 @@ Module Contents :returns: None - .. py:method:: add_user_to_organization(email) Invite a user to your organization. This method will send the specified email address an invitation link to join your organization. @@ -16962,7 +3715,6 @@ Module Contents :type email: str - .. py:method:: create_organization_group(group_name, permissions, default_group = False) Creates a new Organization Group. @@ -16978,7 +3730,6 @@ Module Contents :rtype: OrganizationGroup - .. py:method:: add_organization_group_permission(organization_group_id, permission) Adds a permission to the specified Organization Group. @@ -16989,7 +3740,6 @@ Module Contents :type permission: str - .. py:method:: remove_organization_group_permission(organization_group_id, permission) Removes a permission from the specified Organization Group. @@ -17000,7 +3750,6 @@ Module Contents :type permission: str - .. py:method:: delete_organization_group(organization_group_id) Deletes the specified Organization Group @@ -17009,7 +3758,6 @@ Module Contents :type organization_group_id: str - .. py:method:: add_user_to_organization_group(organization_group_id, email) Adds a user to the specified Organization Group. @@ -17020,7 +3768,6 @@ Module Contents :type email: str - .. py:method:: remove_user_from_organization_group(organization_group_id, email) Removes a user from an Organization Group. @@ -17031,7 +3778,6 @@ Module Contents :type email: str - .. py:method:: set_default_organization_group(organization_group_id) Sets the default Organization Group to which all new users joining an organization are automatically added. @@ -17040,7 +3786,6 @@ Module Contents :type organization_group_id: str - .. py:method:: delete_api_key(api_key_id) Delete a specified API key. @@ -17049,7 +3794,6 @@ Module Contents :type api_key_id: str - .. py:method:: remove_user_from_organization(email) Removes the specified user from the organization. You can remove yourself; otherwise, you must be an organization administrator to use this method to remove other users from the organization. @@ -17058,7 +3802,6 @@ Module Contents :type email: str - .. py:method:: send_email(email, subject, body, is_html = False) Send an email to the specified email address with provided subject and contents. @@ -17073,7 +3816,6 @@ Module Contents :type is_html: bool - .. py:method:: create_deployment_webhook(deployment_id, endpoint, webhook_event_type, payload_template = None) Create a webhook attached to a given deployment ID. @@ -17091,7 +3833,6 @@ Module Contents :rtype: Webhook - .. py:method:: update_webhook(webhook_id, endpoint = None, webhook_event_type = None, payload_template = None) Update the webhook @@ -17106,7 +3847,6 @@ Module Contents :type payload_template: dict - .. py:method:: delete_webhook(webhook_id) Delete the webhook @@ -17115,7 +3855,6 @@ Module Contents :type webhook_id: str - .. py:method:: create_project(name, use_case) Creates a project with the specified project name and use case. Creating a project creates a container for all datasets and models associated with a particular problem/project. For example, if you want to create a model to detect fraud, you need to first create a project, upload datasets, create feature groups, and then create one or more models to get predictions for your use case. @@ -17129,7 +3868,6 @@ Module Contents :rtype: Project - .. py:method:: rename_project(project_id, name) This method renames a project after it is created. @@ -17140,7 +3878,6 @@ Module Contents :type name: str - .. py:method:: delete_project(project_id) Delete a specified project from your organization. @@ -17156,7 +3893,6 @@ Module Contents :type project_id: str - .. py:method:: add_project_tags(project_id, tags) This method adds a tag to a project. @@ -17167,7 +3903,6 @@ Module Contents :type tags: list - .. py:method:: remove_project_tags(project_id, tags) This method removes a tag from a project. @@ -17178,7 +3913,6 @@ Module Contents :type tags: list - .. py:method:: add_feature_group_to_project(feature_group_id, project_id, feature_group_type = 'CUSTOM_TABLE') Adds a feature group to a project. @@ -17191,7 +3925,6 @@ Module Contents :type feature_group_type: str - .. py:method:: set_project_feature_group_config(feature_group_id, project_id, project_config = None) Sets a feature group's project config @@ -17204,7 +3937,6 @@ Module Contents :type project_config: ProjectFeatureGroupConfig - .. py:method:: remove_feature_group_from_project(feature_group_id, project_id) Removes a feature group from a project. @@ -17215,7 +3947,6 @@ Module Contents :type project_id: str - .. py:method:: set_feature_group_type(feature_group_id, project_id, feature_group_type = 'CUSTOM_TABLE') Update the feature group type in a project. The feature group must already be added to the project. @@ -17228,7 +3959,6 @@ Module Contents :type feature_group_type: str - .. py:method:: set_feature_mapping(project_id, feature_group_id, feature_name, feature_mapping = None, nested_column_name = None) Set a column's feature mapping. If the column mapping is single-use and already set in another column in this feature group, this call will first remove the other column's mapping and move it to this column. @@ -17248,7 +3978,6 @@ Module Contents :rtype: list[Feature] - .. py:method:: add_annotation(annotation, feature_group_id, feature_name, doc_id = None, feature_group_row_identifier = None, annotation_source = 'ui', status = None, comments = None, project_id = None, save_metadata = False, pages = None) Add an annotation entry to the database. @@ -17280,7 +4009,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: describe_annotation(feature_group_id, feature_name = None, doc_id = None, feature_group_row_identifier = None) Get the latest annotation entry for a given feature group, feature, and document. @@ -17298,7 +4026,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: update_annotation_status(feature_group_id, feature_name, status, doc_id = None, feature_group_row_identifier = None, save_metadata = False) Update the status of an annotation entry. @@ -17320,7 +4047,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: get_document_to_annotate(feature_group_id, project_id, feature_name, feature_group_row_identifier = None, get_previous = False) Get an available document that needs to be annotated for a annotation feature group. @@ -17340,7 +4066,6 @@ Module Contents :rtype: AnnotationDocument - .. py:method:: import_annotation_labels(feature_group_id, file, annotation_type) Imports annotation labels from csv file. All valid values in the file will be imported as labels (including header row if present). @@ -17356,7 +4081,6 @@ Module Contents :rtype: AnnotationConfig - .. py:method:: create_feature_group(table_name, sql, description = None) Creates a new FeatureGroup from a SQL statement. @@ -17372,7 +4096,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_feature_group_from_template(table_name, feature_group_template_id, template_bindings = None, should_attach_feature_group_to_template = True, description = None) Creates a new feature group from a SQL statement. @@ -17392,7 +4115,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_feature_group_from_function(table_name, function_source_code = None, function_name = None, input_feature_groups = None, description = None, cpu_size = None, memory = None, package_requirements = None, use_original_csv_names = False, python_function_name = None, python_function_bindings = None, use_gpu = None) Creates a new feature in a Feature Group from user-provided code. Currently supported code languages are Python. @@ -17413,9 +4135,9 @@ Module Contents :param description: The description for this feature group. :type description: str :param cpu_size: Size of the CPU for the feature group function. - :type cpu_size: str + :type cpu_size: CPUSize :param memory: Memory (in GB) for the feature group function. - :type memory: int + :type memory: MemorySize :param package_requirements: List of package requirements for the feature group function. For example: ['numpy==1.2.3', 'pandas>=1.4.0'] :type package_requirements: list :param use_original_csv_names: Defaults to False, if set it uses the original column names for input feature groups from CSV datasets. @@ -17431,7 +4153,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_sampling_feature_group(feature_group_id, table_name, sampling_config, description = None) Creates a new Feature Group defined as a sample of rows from another Feature Group. @@ -17452,7 +4173,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_merge_feature_group(source_feature_group_id, table_name, merge_config, description = None) Creates a new feature group defined as the union of other feature group versions. @@ -17469,7 +4189,6 @@ Module Contents Creates a new feature group defined as the union of other feature group versions. - .. py:method:: create_operator_feature_group(source_feature_group_id, table_name, operator_config, description = None) Creates a new Feature Group defined by a pre-defined operator applied to another Feature Group. @@ -17478,8 +4197,8 @@ Module Contents :type source_feature_group_id: str :param table_name: Unique string identifier for the operator Feature Group. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. :type table_name: str - :param operator_config: JSON object (aka map) defining the operator and its parameters. - :type operator_config: dict + :param operator_config: The operator config is used to define the operator and its parameters. + :type operator_config: OperatorConfig :param description: Human-readable description of the Feature Group. :type description: str @@ -17487,7 +4206,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_snapshot_feature_group(feature_group_version, table_name) Creates a Snapshot Feature Group corresponding to a specific Feature Group version. @@ -17501,7 +4219,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_online_feature_group(table_name, primary_key, description = None) Creates an Online Feature Group. @@ -17517,7 +4234,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_group_sampling_config(feature_group_id, sampling_config) Set a FeatureGroup’s sampling to the config values provided, so that the rows the FeatureGroup returns will be a sample of those it would otherwise have returned. @@ -17531,7 +4247,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_group_merge_config(feature_group_id, merge_config) Set a MergeFeatureGroup’s merge config to the values provided, so that the feature group only returns a bounded range of an incremental dataset. @@ -17545,7 +4260,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_group_operator_config(feature_group_id, operator_config) Set a OperatorFeatureGroup’s operator config to the values provided. @@ -17553,8 +4267,10 @@ Module Contents :param feature_group_id: A unique string identifier associated with the feature group. :type feature_group_id: str :param operator_config: A dictionary object specifying the pre-defined operations. - :type operator_config: dict + :type operator_config: OperatorConfig + :returns: The updated FeatureGroup. + :rtype: FeatureGroup .. py:method:: set_feature_group_schema(feature_group_id, schema) @@ -17567,7 +4283,6 @@ Module Contents :type schema: list - .. py:method:: create_feature(feature_group_id, name, select_expression) Creates a new feature in a Feature Group from a SQL select statement. @@ -17583,7 +4298,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: add_feature_group_tag(feature_group_id, tag) Adds a tag to the feature group @@ -17594,7 +4308,6 @@ Module Contents :type tag: str - .. py:method:: remove_feature_group_tag(feature_group_id, tag) Removes a tag from the specified feature group. @@ -17605,7 +4318,6 @@ Module Contents :type tag: str - .. py:method:: add_annotatable_feature(feature_group_id, name, annotation_type) Add an annotatable feature in a Feature Group @@ -17621,7 +4333,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_as_annotatable_feature(feature_group_id, feature_name, annotation_type, feature_group_row_identifier_feature = None, doc_id_feature = None) Sets an existing feature as an annotatable feature (Feature that can be annotated). @@ -17641,7 +4352,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_annotation_status_feature(feature_group_id, feature_name) Sets a feature as the annotation status feature for a feature group. @@ -17655,7 +4365,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: unset_feature_as_annotatable_feature(feature_group_id, feature_name) Unsets a feature as annotatable @@ -17669,7 +4378,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: add_feature_group_annotation_label(feature_group_id, label_name, annotation_type, label_definition = None) Adds an annotation label @@ -17687,7 +4395,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: remove_feature_group_annotation_label(feature_group_id, label_name) Removes an annotation label @@ -17701,7 +4408,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: add_feature_tag(feature_group_id, feature, tag) Adds a tag on a feature @@ -17714,7 +4420,6 @@ Module Contents :type tag: str - .. py:method:: remove_feature_tag(feature_group_id, feature, tag) Removes a tag from a feature @@ -17727,7 +4432,6 @@ Module Contents :type tag: str - .. py:method:: create_nested_feature(feature_group_id, nested_feature_name, table_name, using_clause, where_clause = None, order_clause = None) Creates a new nested feature in a feature group from a SQL statement. @@ -17749,7 +4453,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_nested_feature(feature_group_id, nested_feature_name, table_name = None, using_clause = None, where_clause = None, order_clause = None, new_nested_feature_name = None) Updates a previously existing nested feature in a feature group. @@ -17773,7 +4476,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: delete_nested_feature(feature_group_id, nested_feature_name) Delete a nested feature. @@ -17787,7 +4489,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_feature(feature_group_id, feature_name, history_table_name, aggregation_keys, timestamp_key, historical_timestamp_key, expression, lookback_window_seconds = None, lookback_window_lag_seconds = 0, lookback_count = None, lookback_until_position = 0) Creates a new point in time feature in a feature group using another historical feature group, window spec, and aggregate expression. @@ -17824,7 +4525,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_feature(feature_group_id, feature_name, history_table_name = None, aggregation_keys = None, timestamp_key = None, historical_timestamp_key = None, expression = None, lookback_window_seconds = None, lookback_window_lag_seconds = None, lookback_count = None, lookback_until_position = None, new_feature_name = None) Updates an existing Point-in-Time (PiT) feature in a feature group. See `createPointInTimeFeature` for detailed semantics. @@ -17858,7 +4558,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_group(feature_group_id, group_name, window_key, aggregation_keys, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = 0, lookback_count = None, lookback_until_position = 0) Create a Point-in-Time Group @@ -17890,7 +4589,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: generate_point_in_time_features(feature_group_id, group_name, columns, window_functions, prefix = None) Generates and adds PIT features given the selected columns to aggregate over, and the operations to include. @@ -17910,7 +4608,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_group(feature_group_id, group_name, window_key = None, aggregation_keys = None, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = None, lookback_count = None, lookback_until_position = None) Update Point-in-Time Group @@ -17942,7 +4639,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: delete_point_in_time_group(feature_group_id, group_name) Delete point in time group @@ -17956,7 +4652,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_group_feature(feature_group_id, group_name, name, expression) Create point in time group feature @@ -17974,7 +4669,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_group_feature(feature_group_id, group_name, name, expression) Update a feature's SQL expression in a point in time group @@ -17992,7 +4686,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_type(feature_group_id, feature, feature_type, project_id = None) Set the type of a feature in a feature group. Specify the feature group ID, feature name, and feature type, and the method will return the new column with the changes reflected. @@ -18010,7 +4703,6 @@ Module Contents :rtype: Schema - .. py:method:: invalidate_streaming_feature_group_data(feature_group_id, invalid_before_timestamp) Invalidates all streaming data with timestamp before invalidBeforeTimestamp @@ -18021,7 +4713,6 @@ Module Contents :type invalid_before_timestamp: int - .. py:method:: concatenate_feature_group_data(feature_group_id, source_feature_group_id, merge_type = 'UNION', replace_until_timestamp = None, skip_materialize = False) Concatenates data from one Feature Group to another. Feature Groups can be merged if their schemas are compatible, they have the special `updateTimestampKey` column, and (if set) the `primaryKey` column. The second operand in the concatenate operation will be appended to the first operand (merge target). @@ -18038,7 +4729,6 @@ Module Contents :type skip_materialize: bool - .. py:method:: remove_concatenation_config(feature_group_id) Removes the concatenation config on a destination feature group. @@ -18047,7 +4737,6 @@ Module Contents :type feature_group_id: str - .. py:method:: set_feature_group_indexing_config(feature_group_id, primary_key = None, update_timestamp_key = None, lookup_keys = None) Sets various attributes of the feature group used for primary key, deployment lookups and streaming updates. @@ -18062,7 +4751,6 @@ Module Contents :type lookup_keys: list - .. py:method:: execute_async_feature_group_operation(query = None, fix_query_on_error = False) Starts the execution of fg operation @@ -18076,7 +4764,6 @@ Module Contents :rtype: ExecuteFeatureGroupOperation - .. py:method:: describe_async_feature_group_operation(feature_group_operation_run_id) Gets the status of the execution of fg operation @@ -18088,7 +4775,6 @@ Module Contents :rtype: ExecuteFeatureGroupOperation - .. py:method:: update_feature_group(feature_group_id, description = None) Modify an existing Feature Group. @@ -18102,7 +4788,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: detach_feature_group_from_template(feature_group_id) Update a feature group to detach it from a template. @@ -18114,7 +4799,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_feature_group_template_bindings(feature_group_id, template_bindings = None) Update the feature group template bindings for a template feature group. @@ -18128,7 +4812,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_feature_group_python_function_bindings(feature_group_id, python_function_bindings) Updates an existing Feature Group's Python function bindings from a user-provided Python Function. If a list of feature groups are supplied within the Python function bindings, we will provide DataFrames (Pandas in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. @@ -18139,7 +4822,6 @@ Module Contents :type python_function_bindings: List - .. py:method:: update_feature_group_python_function(feature_group_id, python_function_name, python_function_bindings = None, cpu_size = None, memory = None, use_gpu = None, use_original_csv_names = None) Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function @@ -18155,16 +4837,15 @@ Module Contents :param python_function_bindings: List of python function arguments. :type python_function_bindings: List :param cpu_size: Size of the CPU for the feature group python function. - :type cpu_size: str + :type cpu_size: CPUSize :param memory: Memory (in GB) for the feature group python function. - :type memory: int + :type memory: MemorySize :param use_gpu: Whether the feature group needs a gpu or not. Otherwise default to CPU. :type use_gpu: bool :param use_original_csv_names: If enabled, it uses the original column names for input feature groups from CSV datasets. :type use_original_csv_names: bool - .. py:method:: update_feature_group_sql_definition(feature_group_id, sql) Updates the SQL statement for a feature group. @@ -18178,7 +4859,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_dataset_feature_group_feature_expression(feature_group_id, feature_expression) Updates the SQL feature expression for a Dataset FeatureGroup's custom features @@ -18192,7 +4872,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_feature(feature_group_id, name, select_expression = None, new_name = None) Modifies an existing feature in a feature group. @@ -18210,7 +4889,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: export_feature_group_version_to_file_connector(feature_group_version, location, export_file_format, overwrite = False) Export Feature group to File Connector. @@ -18228,7 +4906,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: export_feature_group_version_to_database_connector(feature_group_version, database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) Export Feature group to Database Connector. @@ -18252,7 +4929,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: export_feature_group_version_to_console(feature_group_version, export_file_format) Export Feature group to console. @@ -18266,7 +4942,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: set_feature_group_modifier_lock(feature_group_id, locked = True) Lock a feature group to prevent modification. @@ -18277,7 +4952,6 @@ Module Contents :type locked: bool - .. py:method:: add_user_to_feature_group_modifiers(feature_group_id, email) Adds a user to a feature group. @@ -18288,7 +4962,6 @@ Module Contents :type email: str - .. py:method:: add_organization_group_to_feature_group_modifiers(feature_group_id, organization_group_id) Add OrganizationGroup to a feature group modifiers list @@ -18299,7 +4972,6 @@ Module Contents :type organization_group_id: str - .. py:method:: remove_user_from_feature_group_modifiers(feature_group_id, email) Removes a user from a specified feature group. @@ -18310,7 +4982,6 @@ Module Contents :type email: str - .. py:method:: remove_organization_group_from_feature_group_modifiers(feature_group_id, organization_group_id) Removes an OrganizationGroup from a feature group modifiers list @@ -18321,7 +4992,6 @@ Module Contents :type organization_group_id: str - .. py:method:: delete_feature(feature_group_id, name) Removes a feature from the feature group. @@ -18335,7 +5005,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: delete_feature_group(feature_group_id) Deletes a Feature Group. @@ -18344,7 +5013,6 @@ Module Contents :type feature_group_id: str - .. py:method:: create_feature_group_version(feature_group_id, variable_bindings = None) Creates a snapshot for a specified feature group. Triggers materialization of the feature group. The new version of the feature group is created after it has materialized. @@ -18358,7 +5026,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: create_feature_group_template(feature_group_id, name, template_sql, template_variables, description = None, template_bindings = None, should_attach_feature_group_to_template = False) Create a feature group template. @@ -18382,7 +5049,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: delete_feature_group_template(feature_group_template_id) Delete an existing feature group template. @@ -18391,7 +5057,6 @@ Module Contents :type feature_group_template_id: str - .. py:method:: update_feature_group_template(feature_group_template_id, template_sql = None, template_variables = None, description = None, name = None) Update a feature group template. @@ -18411,7 +5076,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: preview_feature_group_template_resolution(feature_group_template_id = None, template_bindings = None, template_sql = None, template_variables = None, should_validate = True) Resolve template sql using template variables and template bindings. @@ -18431,7 +5095,6 @@ Module Contents :rtype: ResolvedFeatureGroupTemplate - .. py:method:: cancel_upload(upload_id) Cancels an upload. @@ -18440,7 +5103,6 @@ Module Contents :type upload_id: str - .. py:method:: upload_part(upload_id, part_number, part_data) Uploads part of a large dataset file from your bucket to our system. Our system currently supports parts of up to 5GB and full files of up to 5TB. Note that each part must be at least 5MB in size, unless it is the last part in the sequence of parts for the full file. @@ -18456,7 +5118,6 @@ Module Contents :rtype: UploadPart - .. py:method:: mark_upload_complete(upload_id) Marks an upload process as complete. @@ -18468,7 +5129,6 @@ Module Contents :rtype: Upload - .. py:method:: create_dataset_from_file_connector(table_name, location, file_format = None, refresh_schedule = None, csv_delimiter = None, filename_column = None, start_prefix = None, until_prefix = None, location_date_format = None, date_format_lookback_days = None, incremental = False, is_documentset = False, extract_bounding_boxes = False, document_processing_config = None, merge_file_schemas = False, reference_only_documentset = False, parsing_config = None) Creates a dataset from a file located in a cloud storage, such as Amazon AWS S3, using the specified dataset name and location. @@ -18512,7 +5172,6 @@ Module Contents :rtype: Dataset - .. py:method:: create_dataset_version_from_file_connector(dataset_id, location = None, file_format = None, csv_delimiter = None, merge_file_schemas = None, parsing_config = None) Creates a new version of the specified dataset. @@ -18534,7 +5193,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_dataset_from_database_connector(table_name, database_connector_id, object_name = None, columns = None, query_arguments = None, refresh_schedule = None, sql_query = None, incremental = False, incremental_database_connector_config = None) Creates a dataset from a Database Connector. @@ -18562,7 +5220,6 @@ Module Contents :rtype: Dataset - .. py:method:: create_dataset_from_application_connector(table_name, application_connector_id, dataset_config = None, refresh_schedule = None) Creates a dataset from an Application Connector. @@ -18580,7 +5237,6 @@ Module Contents :rtype: Dataset - .. py:method:: create_dataset_version_from_database_connector(dataset_id, object_name = None, columns = None, query_arguments = None, sql_query = None) Creates a new version of the specified dataset. @@ -18600,7 +5256,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_dataset_version_from_application_connector(dataset_id, dataset_config = None) Creates a new version of the specified dataset. @@ -18614,7 +5269,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_dataset_from_upload(table_name, file_format = None, csv_delimiter = None, is_documentset = False, extract_bounding_boxes = False, parsing_config = None, merge_file_schemas = False, document_processing_config = None) Creates a dataset and returns an upload ID that can be used to upload a file. @@ -18640,7 +5294,6 @@ Module Contents :rtype: Upload - .. py:method:: create_dataset_version_from_upload(dataset_id, file_format = None) Creates a new version of the specified dataset using a local file upload. @@ -18654,7 +5307,6 @@ Module Contents :rtype: Upload - .. py:method:: create_dataset_version_from_document_reprocessing(dataset_id, document_processing_config = None) Creates a new dataset version for a source docstore dataset with the provided document processing configuration. This does not re-import the data but uses the same data which is imported in the latest dataset version and only performs document processing on it. @@ -18668,7 +5320,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_streaming_dataset(table_name, primary_key = None, update_timestamp_key = None, lookup_keys = None) Creates a streaming dataset. Use a streaming dataset if your dataset is receiving information from multiple sources over an extended period of time. @@ -18686,7 +5337,6 @@ Module Contents :rtype: Dataset - .. py:method:: snapshot_streaming_data(dataset_id) Snapshots the current data in the streaming dataset. @@ -18698,7 +5348,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: set_dataset_column_data_type(dataset_id, column, data_type) Set a Dataset's column type. @@ -18714,8 +5363,7 @@ Module Contents :rtype: Dataset - - .. py:method:: create_dataset_from_streaming_connector(table_name, streaming_connector_id, streaming_args = None, refresh_schedule = None) + .. py:method:: create_dataset_from_streaming_connector(table_name, streaming_connector_id, dataset_config = None, refresh_schedule = None) Creates a dataset from a Streaming Connector @@ -18723,8 +5371,8 @@ Module Contents :type table_name: str :param streaming_connector_id: Unique String Identifier for the Streaming Connector to import the dataset from :type streaming_connector_id: str - :param streaming_args: Dictionary of arguments to read data from the streaming connector - :type streaming_args: dict + :param dataset_config: Streaming dataset config + :type dataset_config: StreamingConnectorDatasetConfig :param refresh_schedule: Cron time string format that describes a schedule to retrieve the latest version of the imported dataset. Time is specified in UTC. :type refresh_schedule: str @@ -18732,7 +5380,6 @@ Module Contents :rtype: Dataset - .. py:method:: set_streaming_retention_policy(dataset_id, retention_hours = None, retention_row_count = None, ignore_records_before_timestamp = None) Sets the streaming retention policy. @@ -18747,7 +5394,6 @@ Module Contents :type ignore_records_before_timestamp: int - .. py:method:: rename_database_connector(database_connector_id, name) Renames a Database Connector @@ -18758,7 +5404,6 @@ Module Contents :type name: str - .. py:method:: rename_application_connector(application_connector_id, name) Renames a Application Connector @@ -18769,7 +5414,6 @@ Module Contents :type name: str - .. py:method:: verify_database_connector(database_connector_id) Checks if Abacus.AI can access the specified database. @@ -18778,7 +5422,6 @@ Module Contents :type database_connector_id: str - .. py:method:: verify_file_connector(bucket) Checks to see if Abacus.AI can access the given bucket. @@ -18790,7 +5433,6 @@ Module Contents :rtype: FileConnectorVerification - .. py:method:: delete_database_connector(database_connector_id) Delete a database connector. @@ -18799,7 +5441,6 @@ Module Contents :type database_connector_id: str - .. py:method:: delete_application_connector(application_connector_id) Delete an application connector. @@ -18808,7 +5449,6 @@ Module Contents :type application_connector_id: str - .. py:method:: delete_file_connector(bucket) Deletes a file connector @@ -18817,7 +5457,6 @@ Module Contents :type bucket: str - .. py:method:: verify_application_connector(application_connector_id) Checks if Abacus.AI can access the application using the provided application connector ID. @@ -18826,7 +5465,6 @@ Module Contents :type application_connector_id: str - .. py:method:: set_azure_blob_connection_string(bucket, connection_string) Authenticates the specified Azure Blob Storage bucket using an authenticated Connection String. @@ -18840,7 +5478,6 @@ Module Contents :rtype: FileConnectorVerification - .. py:method:: verify_streaming_connector(streaming_connector_id) Checks to see if Abacus.AI can access the streaming connector. @@ -18849,7 +5486,6 @@ Module Contents :type streaming_connector_id: str - .. py:method:: rename_streaming_connector(streaming_connector_id, name) Renames a Streaming Connector @@ -18860,7 +5496,6 @@ Module Contents :type name: str - .. py:method:: delete_streaming_connector(streaming_connector_id) Delete a streaming connector. @@ -18869,7 +5504,6 @@ Module Contents :type streaming_connector_id: str - .. py:method:: create_streaming_token() Creates a streaming token for the specified project. Streaming tokens are used to authenticate requests when appending data to streaming datasets. @@ -18878,7 +5512,6 @@ Module Contents :rtype: StreamingAuthToken - .. py:method:: delete_streaming_token(streaming_token) Deletes the specified streaming token. @@ -18887,7 +5520,6 @@ Module Contents :type streaming_token: str - .. py:method:: delete_dataset(dataset_id) Deletes the specified dataset from the organization. @@ -18896,7 +5528,6 @@ Module Contents :type dataset_id: str - .. py:method:: get_docstore_page_data(doc_id, page, document_processing_config = None, document_processing_version = None) Returns the extracted page data for a document page. @@ -18914,7 +5545,6 @@ Module Contents :rtype: PageData - .. py:method:: get_docstore_document_data(doc_id, document_processing_config = None, document_processing_version = None, return_extracted_page_text = False) Returns the extracted data for a document. @@ -18932,7 +5562,6 @@ Module Contents :rtype: DocumentData - .. py:method:: extract_document_data(document = None, doc_id = None, document_processing_config = None, start_page = None, end_page = None, return_extracted_page_text = False) Extracts data from a document. @@ -18954,7 +5583,6 @@ Module Contents :rtype: DocumentData - .. py:method:: get_training_config_options(project_id, feature_group_ids = None, for_retrain = False, current_training_config = None) Retrieves the full initial description of the model training configuration options available for the specified project. The configuration options available are determined by the use case associated with the specified project. Refer to the [Use Case Documentation]({USE_CASES_URL}) for more information on use cases and use case-specific configuration options. @@ -18972,7 +5600,6 @@ Module Contents :rtype: list[TrainingConfigOptions] - .. py:method:: create_train_test_data_split_feature_group(project_id, training_config, feature_group_ids) Get the train and test data split without training the model. Only supported for models with custom algorithms. @@ -18988,7 +5615,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: train_model(project_id, name = None, training_config = None, feature_group_ids = None, refresh_schedule = None, custom_algorithms = None, custom_algorithms_only = False, custom_algorithm_configs = None, builtin_algorithms = None, cpu_size = None, memory = None, algorithm_training_configs = None) Create a new model and start its training in the given project. @@ -19022,7 +5648,6 @@ Module Contents :rtype: Model - .. py:method:: create_model_from_python(project_id, function_source_code, train_function_name, training_input_tables, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, name = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False, package_requirements = None, use_gpu = False, is_thread_safe = None) Initializes a new Model from user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -19065,7 +5690,6 @@ Module Contents :rtype: Model - .. py:method:: rename_model(model_id, name) Renames a model @@ -19076,7 +5700,6 @@ Module Contents :type name: str - .. py:method:: update_python_model(model_id, function_source_code = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None, is_thread_safe = None, training_config = None) Updates an existing Python Model using user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the `train` and `predict` functions with the materialized feature groups for those input feature groups. @@ -19115,7 +5738,6 @@ Module Contents :rtype: Model - .. py:method:: update_python_model_zip(model_id, train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) Updates an existing Python Model using a provided zip file. If a list of input feature groups are supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -19150,7 +5772,6 @@ Module Contents :rtype: Upload - .. py:method:: update_python_model_git(model_id, application_connector_id = None, branch_name = None, python_root = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, use_gpu = None) Updates an existing Python model using an existing Git application connector. If a list of input feature groups are supplied, these will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -19189,7 +5810,6 @@ Module Contents :rtype: Model - .. py:method:: set_model_training_config(model_id, training_config, feature_group_ids = None) Edits the default model training config @@ -19205,7 +5825,6 @@ Module Contents :rtype: Model - .. py:method:: set_model_objective(model_version, metric = None) Sets the best model for all model instances of the model based on the specified metric, and updates the training configuration to use the specified metric for any future model versions. @@ -19219,7 +5838,6 @@ Module Contents :type metric: str - .. py:method:: set_model_prediction_params(model_id, prediction_config) Sets the model prediction config for the model @@ -19233,7 +5851,6 @@ Module Contents :rtype: Model - .. py:method:: retrain_model(model_id, deployment_ids = None, feature_group_ids = None, custom_algorithms = None, builtin_algorithms = None, custom_algorithm_configs = None, cpu_size = None, memory = None, training_config = None, algorithm_training_configs = None) Retrains the specified model, with an option to choose the deployments to which the retraining will be deployed. @@ -19263,7 +5880,6 @@ Module Contents :rtype: Model - .. py:method:: delete_model(model_id) Deletes the specified model and all its versions. Models which are currently used in deployments cannot be deleted. @@ -19272,7 +5888,6 @@ Module Contents :type model_id: str - .. py:method:: delete_model_version(model_version) Deletes the specified model version. Model versions which are currently used in deployments cannot be deleted. @@ -19281,7 +5896,6 @@ Module Contents :type model_version: str - .. py:method:: export_model_artifact_as_feature_group(model_version, table_name, artifact_type = None) Exports metric artifact data for a model as a feature group. @@ -19297,7 +5911,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_default_model_algorithm(model_id = None, algorithm = None, data_cluster_type = None) Sets the model's algorithm to default for all new deployments @@ -19310,7 +5923,6 @@ Module Contents :type data_cluster_type: str - .. py:method:: get_custom_train_function_info(project_id, feature_group_names_for_training = None, training_data_parameter_name_override = None, training_config = None, custom_algorithm_config = None) Returns information about how to call the custom train function. @@ -19330,7 +5942,6 @@ Module Contents :rtype: CustomTrainFunctionInfo - .. py:method:: export_custom_model_version(model_version, output_location, algorithm = None) Bundle custom model artifacts to a zip file, and export to the specified location. @@ -19346,8 +5957,7 @@ Module Contents :rtype: ModelArtifactsExport - - .. py:method:: create_model_monitor(project_id, prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, include_interactive_performance_analysis = False) + .. py:method:: create_model_monitor(project_id, prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, exclude_interactive_performance_analysis = True, exclude_bias_analysis = None, exclude_performance_analysis = None, exclude_feature_drift_analysis = None, exclude_data_integrity_analysis = None) Runs a model monitor for the specified project. @@ -19377,14 +5987,21 @@ Module Contents :type feature_group_base_monitor_config: dict :param feature_group_comparison_monitor_config: Selection strategy for the feature_group 1 with the feature group version if selected. :type feature_group_comparison_monitor_config: dict - :param include_interactive_performance_analysis: Whether to include interactive performance analysis. - :type include_interactive_performance_analysis: bool + :param exclude_interactive_performance_analysis: Whether to exclude interactive performance analysis. Defaults to True if not provided. + :type exclude_interactive_performance_analysis: bool + :param exclude_bias_analysis: Whether to exclude bias analysis in the model monitor. For default value bias analysis is included. + :type exclude_bias_analysis: bool + :param exclude_performance_analysis: Whether to exclude performance analysis in the model monitor. For default value performance analysis is included. + :type exclude_performance_analysis: bool + :param exclude_feature_drift_analysis: Whether to exclude feature drift analysis in the model monitor. For default value feature drift analysis is included. + :type exclude_feature_drift_analysis: bool + :param exclude_data_integrity_analysis: Whether to exclude data integrity analysis in the model monitor. For default value data integrity analysis is included. + :type exclude_data_integrity_analysis: bool :returns: The new model monitor that was created. :rtype: ModelMonitor - .. py:method:: rerun_model_monitor(model_monitor_id) Re-runs the specified model monitor. @@ -19396,7 +6013,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: rename_model_monitor(model_monitor_id, name) Renames a model monitor @@ -19407,7 +6023,6 @@ Module Contents :type name: str - .. py:method:: delete_model_monitor(model_monitor_id) Deletes the specified Model Monitor and all its versions. @@ -19416,7 +6031,6 @@ Module Contents :type model_monitor_id: str - .. py:method:: delete_model_monitor_version(model_monitor_version) Deletes the specified model monitor version. @@ -19425,7 +6039,6 @@ Module Contents :type model_monitor_version: str - .. py:method:: create_vision_drift_monitor(project_id, prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) Runs a vision drift monitor for the specified project. @@ -19451,7 +6064,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: create_nlp_drift_monitor(project_id, prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) Runs an NLP drift monitor for the specified project. @@ -19477,7 +6089,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: create_forecasting_monitor(project_id, name, prediction_feature_group_id, training_feature_group_id, training_forecast_config, prediction_forecast_config, forecast_frequency, refresh_schedule = None) Runs a forecasting monitor for the specified project. @@ -19503,7 +6114,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: create_eda(project_id, feature_group_id, name, refresh_schedule = None, include_collinearity = False, include_data_consistency = False, collinearity_keys = None, primary_keys = None, data_consistency_test_config = None, data_consistency_reference_config = None, feature_mappings = None, forecast_frequency = None) Run an Exploratory Data Analysis (EDA) for the specified project. @@ -19537,7 +6147,6 @@ Module Contents :rtype: Eda - .. py:method:: rerun_eda(eda_id) Reruns the specified EDA object. @@ -19549,7 +6158,6 @@ Module Contents :rtype: Eda - .. py:method:: rename_eda(eda_id, name) Renames an EDA @@ -19560,7 +6168,6 @@ Module Contents :type name: str - .. py:method:: delete_eda(eda_id) Deletes the specified EDA and all its versions. @@ -19569,7 +6176,6 @@ Module Contents :type eda_id: str - .. py:method:: delete_eda_version(eda_version) Deletes the specified EDA version. @@ -19578,7 +6184,6 @@ Module Contents :type eda_version: str - .. py:method:: create_holdout_analysis(name, model_id, feature_group_ids, model_version = None, algorithm = None) Create a holdout analysis for a model @@ -19598,7 +6203,6 @@ Module Contents :rtype: HoldoutAnalysis - .. py:method:: rerun_holdout_analysis(holdout_analysis_id, model_version = None, algorithm = None) Rerun a holdout analysis. A different model version and algorithm can be specified which should be under the same model. @@ -19614,7 +6218,6 @@ Module Contents :rtype: HoldoutAnalysisVersion - .. py:method:: create_monitor_alert(project_id, alert_name, condition_config, action_config, model_monitor_id = None, realtime_monitor_id = None) Create a monitor alert for the given conditions and monitor. We can create monitor alert either for model monitor or real-time monitor. @@ -19636,7 +6239,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: update_monitor_alert(monitor_alert_id, alert_name = None, condition_config = None, action_config = None) Update monitor alert @@ -19654,7 +6256,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: run_monitor_alert(monitor_alert_id) Reruns a given monitor alert from latest monitor instance @@ -19666,7 +6267,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: delete_monitor_alert(monitor_alert_id) Delets a monitor alert @@ -19675,7 +6275,6 @@ Module Contents :type monitor_alert_id: str - .. py:method:: create_prediction_operator(name, project_id, source_code = None, predict_function_name = None, initialize_function_name = None, feature_group_ids = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = False) Create a new prediction operator. @@ -19705,7 +6304,6 @@ Module Contents :rtype: PredictionOperator - .. py:method:: update_prediction_operator(prediction_operator_id, name = None, feature_group_ids = None, source_code = None, initialize_function_name = None, predict_function_name = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) Update an existing prediction operator. @@ -19735,7 +6333,6 @@ Module Contents :rtype: PredictionOperator - .. py:method:: delete_prediction_operator(prediction_operator_id) Delete an existing prediction operator. @@ -19744,7 +6341,6 @@ Module Contents :type prediction_operator_id: str - .. py:method:: deploy_prediction_operator(prediction_operator_id, auto_deploy = True) Deploy the prediction operator. @@ -19758,7 +6354,6 @@ Module Contents :rtype: Deployment - .. py:method:: create_prediction_operator_version(prediction_operator_id) Create a new version of the prediction operator. @@ -19770,7 +6365,6 @@ Module Contents :rtype: PredictionOperatorVersion - .. py:method:: delete_prediction_operator_version(prediction_operator_version) Delete a prediction operator version. @@ -19779,7 +6373,6 @@ Module Contents :type prediction_operator_version: str - .. py:method:: create_deployment(name = None, model_id = None, model_version = None, algorithm = None, feature_group_id = None, project_id = None, description = None, calls_per_second = None, auto_deploy = True, start = True, enable_batch_streaming_updates = False, skip_metrics_check = False, model_deployment_config = None) Creates a deployment with the specified name and description for the specified model or feature group. @@ -19818,7 +6411,6 @@ Module Contents :rtype: Deployment - .. py:method:: create_deployment_token(project_id, name = None) Creates a deployment token for the specified project. @@ -19835,7 +6427,6 @@ Module Contents :rtype: DeploymentAuthToken - .. py:method:: update_deployment(deployment_id, description = None, auto_deploy = None, skip_metrics_check = None) Updates a deployment's properties. @@ -19850,7 +6441,6 @@ Module Contents :type skip_metrics_check: bool - .. py:method:: rename_deployment(deployment_id, name) Updates a deployment's name @@ -19861,7 +6451,6 @@ Module Contents :type name: str - .. py:method:: set_auto_deployment(deployment_id, enable = None) Enable or disable auto deployment for the specified deployment. @@ -19875,7 +6464,6 @@ Module Contents :type enable: bool - .. py:method:: set_deployment_model_version(deployment_id, model_version, algorithm = None, model_deployment_config = None) Promotes a model version and/or algorithm to be the active served deployment version @@ -19890,7 +6478,6 @@ Module Contents :type model_deployment_config: dict - .. py:method:: set_deployment_feature_group_version(deployment_id, feature_group_version) Promotes a feature group version to be served in the deployment. @@ -19901,7 +6488,6 @@ Module Contents :type feature_group_version: str - .. py:method:: set_deployment_prediction_operator_version(deployment_id, prediction_operator_version) Promotes a prediction operator version to be served in the deployment. @@ -19912,7 +6498,6 @@ Module Contents :type prediction_operator_version: str - .. py:method:: start_deployment(deployment_id) Restarts the specified deployment that was previously suspended. @@ -19921,7 +6506,6 @@ Module Contents :type deployment_id: str - .. py:method:: stop_deployment(deployment_id) Stops the specified deployment. @@ -19930,7 +6514,6 @@ Module Contents :type deployment_id: str - .. py:method:: delete_deployment(deployment_id) Deletes the specified deployment. The deployment's models will not be affected. Note that the deployments are not recoverable after they are deleted. @@ -19939,7 +6522,6 @@ Module Contents :type deployment_id: str - .. py:method:: delete_deployment_token(deployment_token) Deletes the specified deployment token. @@ -19948,7 +6530,6 @@ Module Contents :type deployment_token: str - .. py:method:: set_deployment_feature_group_export_file_connector_output(deployment_id, file_format = None, output_location = None) Sets the export output for the Feature Group Deployment to be a file connector. @@ -19961,7 +6542,6 @@ Module Contents :type output_location: str - .. py:method:: set_deployment_feature_group_export_database_connector_output(deployment_id, database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) Sets the export output for the Feature Group Deployment to a Database connector. @@ -19982,7 +6562,6 @@ Module Contents :type additional_id_columns: list - .. py:method:: remove_deployment_feature_group_export_output(deployment_id) Removes the export type that is set for the Feature Group Deployment @@ -19991,7 +6570,6 @@ Module Contents :type deployment_id: str - .. py:method:: set_default_prediction_arguments(deployment_id, prediction_arguments, set_as_override = False) Sets the deployment config. @@ -20007,7 +6585,6 @@ Module Contents :rtype: Deployment - .. py:method:: create_deployment_alert(deployment_id, alert_name, condition_config, action_config) Create a deployment alert for the given conditions. @@ -20028,7 +6605,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: create_realtime_monitor(deployment_id, realtime_monitor_schedule = None, lookback_time = None) Real time monitors compute and monitor metrics of real time prediction data. @@ -20044,7 +6620,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: update_realtime_monitor(realtime_monitor_id, realtime_monitor_schedule = None, lookback_time = None) Update the real-time monitor associated with the real-time monitor id. @@ -20060,7 +6635,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: delete_realtime_monitor(realtime_monitor_id) Delete the real-time monitor associated with the real-time monitor id. @@ -20069,7 +6643,6 @@ Module Contents :type realtime_monitor_id: str - .. py:method:: create_refresh_policy(name, cron, refresh_type, project_id = None, dataset_ids = [], feature_group_id = None, model_ids = [], deployment_ids = [], batch_prediction_ids = [], model_monitor_ids = [], notebook_id = None, prediction_operator_id = None, feature_group_export_config = None) Creates a refresh policy with a particular cron pattern and refresh type. The cron is specified in UTC time. @@ -20108,7 +6681,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: delete_refresh_policy(refresh_policy_id) Delete a refresh policy. @@ -20117,7 +6689,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: pause_refresh_policy(refresh_policy_id) Pauses a refresh policy @@ -20126,7 +6697,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: resume_refresh_policy(refresh_policy_id) Resumes a refresh policy @@ -20135,7 +6705,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: run_refresh_policy(refresh_policy_id) Force a run of the refresh policy. @@ -20144,7 +6713,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: update_refresh_policy(refresh_policy_id, name = None, cron = None, feature_group_export_config = None) Update the name or cron string of a refresh policy @@ -20162,7 +6730,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: lookup_features(deployment_token, deployment_id, query_data, limit_results = None, result_columns = None) Returns the feature group deployed in the feature store project. @@ -20179,7 +6746,6 @@ Module Contents :type result_columns: list - .. py:method:: predict(deployment_token, deployment_id, query_data) Returns a prediction for Predictive Modeling @@ -20192,7 +6758,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_multiple(deployment_token, deployment_id, query_data) Returns a list of predictions for predictive modeling. @@ -20205,7 +6770,6 @@ Module Contents :type query_data: list - .. py:method:: predict_from_datasets(deployment_token, deployment_id, query_data) Returns a list of predictions for Predictive Modeling. @@ -20218,7 +6782,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_lead(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user being a lead based on their interaction with the service/product and their own attributes (e.g. income, assets, credit score, etc.). Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'user_id' mapped to mapping 'LEAD_ID' in our system). @@ -20235,7 +6798,6 @@ Module Contents :type explainer_type: str - .. py:method:: predict_churn(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user to churn out in response to their interactions with the item/product/service. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'churn_result' mapped to mapping 'CHURNED_YN' in our system). @@ -20252,7 +6814,6 @@ Module Contents :type explainer_type: str - .. py:method:: predict_takeover(deployment_token, deployment_id, query_data) Returns a probability for each class label associated with the types of fraud or a 'yes' or 'no' type label for the possibility of fraud. Note that the inputs to this method, wherever applicable, will be the column names in the dataset mapped to the column mappings in our system (e.g., column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -20265,7 +6826,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_fraud(deployment_token, deployment_id, query_data) Returns the probability of a transaction performed under a specific account being fraudulent or not. Note that the inputs to this method, wherever applicable, should be the column names in your dataset mapped to the column mappings in our system (e.g. column 'account_number' mapped to the mapping 'ACCOUNT_ID' in our system). @@ -20278,7 +6838,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_class(deployment_token, deployment_id, query_data, threshold = None, threshold_class = None, thresholds = None, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a classification prediction @@ -20305,7 +6864,6 @@ Module Contents :type explainer_type: str - .. py:method:: predict_target(deployment_token, deployment_id, query_data, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a prediction from a classification or regression model. Optionally, includes explanations. @@ -20326,7 +6884,6 @@ Module Contents :type explainer_type: str - .. py:method:: get_anomalies(deployment_token, deployment_id, threshold = None, histogram = False) Returns a list of anomalies from the training dataset. @@ -20341,7 +6898,6 @@ Module Contents :type histogram: bool - .. py:method:: get_timeseries_anomalies(deployment_token, deployment_id, start_timestamp = None, end_timestamp = None, query_data = None, get_all_item_data = False, series_ids = None) Returns a list of anomalous timestamps from the training dataset. @@ -20362,7 +6918,6 @@ Module Contents :type series_ids: list - .. py:method:: is_anomaly(deployment_token, deployment_id, query_data = None) Returns a list of anomaly attributes based on login information for a specified account. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -20375,7 +6930,6 @@ Module Contents :type query_data: dict - .. py:method:: get_event_anomaly_score(deployment_token, deployment_id, query_data = None) Returns an anomaly score for an event. @@ -20388,7 +6942,6 @@ Module Contents :type query_data: dict - .. py:method:: get_forecast(deployment_token, deployment_id, query_data, future_data = None, num_predictions = None, prediction_start = None, explain_predictions = False, explainer_type = None, get_item_data = False) Returns a list of forecasts for a given entity under the specified project deployment. Note that the inputs to the deployed model will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'holiday_yn' mapped to mapping 'FUTURE' in our system). @@ -20413,7 +6966,6 @@ Module Contents :type get_item_data: bool - .. py:method:: get_k_nearest(deployment_token, deployment_id, vector, k = None, distance = None, include_score = False, catalog_id = None) Returns the k nearest neighbors for the provided embedding vector. @@ -20434,7 +6986,6 @@ Module Contents :type catalog_id: str - .. py:method:: get_multiple_k_nearest(deployment_token, deployment_id, queries) Returns the k nearest neighbors for the queries provided. @@ -20447,7 +6998,6 @@ Module Contents :type queries: list - .. py:method:: get_labels(deployment_token, deployment_id, query_data, return_extracted_entities = False) Returns a list of scored labels for a document. @@ -20462,7 +7012,6 @@ Module Contents :type return_extracted_entities: bool - .. py:method:: get_entities_from_pdf(deployment_token, deployment_id, pdf = None, doc_id = None, return_extracted_features = False, verbose = False, save_extracted_features = None) Extracts text from the provided PDF and returns a list of recognized labels and their scores. @@ -20483,7 +7032,6 @@ Module Contents :type save_extracted_features: bool - .. py:method:: get_recommendations(deployment_token, deployment_id, query_data, num_items = None, page = None, exclude_item_ids = None, score_field = None, scaling_factors = None, restrict_items = None, exclude_items = None, explore_fraction = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of recommendations for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'time' mapped to mapping 'TIMESTAMP' in our system). @@ -20514,7 +7062,6 @@ Module Contents :type diversity_max_results_per_value: int - .. py:method:: get_personalized_ranking(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, scaling_factors = None) Returns a list of items with personalized promotions for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -20533,7 +7080,6 @@ Module Contents :type scaling_factors: list - .. py:method:: get_ranked_items(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, score_field = None, scaling_factors = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of re-ranked items for a selected user when a list of items is required to be reranked according to the user's preferences. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -20558,7 +7104,6 @@ Module Contents :type diversity_max_results_per_value: int - .. py:method:: get_related_items(deployment_token, deployment_id, query_data, num_items = None, page = None, scaling_factors = None, restrict_items = None, exclude_items = None) Returns a list of related items for a given item under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -20581,7 +7126,6 @@ Module Contents :type exclude_items: list - .. py:method:: get_chat_response(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False) Return a chat response which continues the conversation based on the input messages and search results. @@ -20610,7 +7154,6 @@ Module Contents :type ignore_documents: bool - .. py:method:: get_chat_response_with_binary_data(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a chat response which continues the conversation based on the input messages and search results. @@ -20641,7 +7184,6 @@ Module Contents :type attachments: None - .. py:method:: get_conversation_response(deployment_id, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, deployment_token = None, doc_infos = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -20676,7 +7218,6 @@ Module Contents :type doc_infos: list - .. py:method:: get_conversation_response_with_binary_data(deployment_id, deployment_token, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -20711,7 +7252,6 @@ Module Contents :type attachments: None - .. py:method:: get_search_results(deployment_token, deployment_id, query_data, num = 15) Return the most relevant search results to the search query from the uploaded documents. @@ -20726,7 +7266,6 @@ Module Contents :type num: int - .. py:method:: get_sentiment(deployment_token, deployment_id, document) Predicts sentiment on a document @@ -20739,7 +7278,6 @@ Module Contents :type document: str - .. py:method:: get_entailment(deployment_token, deployment_id, document) Predicts the classification of the document @@ -20752,7 +7290,6 @@ Module Contents :type document: str - .. py:method:: get_classification(deployment_token, deployment_id, document) Predicts the classification of the document @@ -20765,7 +7302,6 @@ Module Contents :type document: str - .. py:method:: get_summary(deployment_token, deployment_id, query_data) Returns a JSON of the predicted summary for the given document. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'text' mapped to mapping 'DOCUMENT' in our system). @@ -20778,7 +7314,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_language(deployment_token, deployment_id, query_data) Predicts the language of the text @@ -20791,7 +7326,6 @@ Module Contents :type query_data: str - .. py:method:: get_assignments(deployment_token, deployment_id, query_data, forced_assignments = None, solve_time_limit_seconds = None, include_all_assignments = False) Get all positive assignments that match a query. @@ -20810,7 +7344,6 @@ Module Contents :type include_all_assignments: bool - .. py:method:: get_alternative_assignments(deployment_token, deployment_id, query_data, add_constraints = None, solve_time_limit_seconds = None, best_alternate_only = False) Get alternative positive assignments for given query. Optimal assignments are ignored and the alternative assignments are returned instead. @@ -20829,7 +7362,6 @@ Module Contents :type best_alternate_only: bool - .. py:method:: check_constraints(deployment_token, deployment_id, query_data) Check for any constraints violated by the overrides. @@ -20842,7 +7374,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_with_binary_data(deployment_token, deployment_id, blob) Make predictions for a given blob, e.g. image, audio @@ -20855,7 +7386,6 @@ Module Contents :type blob: io.TextIOBase - .. py:method:: describe_image(deployment_token, deployment_id, image, categories, top_n = None) Describe the similarity between an image and a list of categories. @@ -20872,7 +7402,6 @@ Module Contents :type top_n: int - .. py:method:: get_text_from_document(deployment_token, deployment_id, document = None, adjust_doc_orientation = False, save_predicted_pdf = False, save_extracted_features = False) Generate text from a document @@ -20891,7 +7420,6 @@ Module Contents :type save_extracted_features: bool - .. py:method:: transcribe_audio(deployment_token, deployment_id, audio) Transcribe the audio @@ -20904,7 +7432,6 @@ Module Contents :type audio: io.TextIOBase - .. py:method:: classify_image(deployment_token, deployment_id, image = None, doc_id = None) Classify an image. @@ -20919,7 +7446,6 @@ Module Contents :type doc_id: str - .. py:method:: classify_pdf(deployment_token, deployment_id, pdf = None) Returns a classification prediction from a PDF @@ -20932,7 +7458,6 @@ Module Contents :type pdf: io.TextIOBase - .. py:method:: get_cluster(deployment_token, deployment_id, query_data) Predicts the cluster for given data. @@ -20945,7 +7470,6 @@ Module Contents :type query_data: dict - .. py:method:: get_objects_from_image(deployment_token, deployment_id, image) Classify an image. @@ -20958,7 +7482,6 @@ Module Contents :type image: io.TextIOBase - .. py:method:: score_image(deployment_token, deployment_id, image) Score on image. @@ -20971,7 +7494,6 @@ Module Contents :type image: io.TextIOBase - .. py:method:: transfer_style(deployment_token, deployment_id, source_image, style_image) Change the source image to adopt the visual style from the style image. @@ -20986,7 +7508,6 @@ Module Contents :type style_image: io.TextIOBase - .. py:method:: generate_image(deployment_token, deployment_id, query_data) Generate an image from text prompt. @@ -20999,7 +7520,6 @@ Module Contents :type query_data: dict - .. py:method:: execute_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -21014,7 +7534,6 @@ Module Contents :type keyword_arguments: dict - .. py:method:: execute_conversation_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, regenerate = False, doc_infos = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -21037,7 +7556,6 @@ Module Contents :type doc_infos: list - .. py:method:: lookup_matches(deployment_token, deployment_id, data = None, filters = None, num = None, result_columns = None, max_words = None, num_retrieval_margin_words = None, max_words_per_chunk = None, score_multiplier_column = None, min_score = None, required_phrases = None, filter_clause = None, crowding_limits = None) Lookup document retrievers and return the matching documents from the document retriever deployed with given query. @@ -21080,7 +7598,6 @@ Module Contents :rtype: list[DocumentRetrieverLookupResult] - .. py:method:: get_completion(deployment_token, deployment_id, prompt) Returns the finetuned LLM generated completion of the prompt. @@ -21093,7 +7610,6 @@ Module Contents :type prompt: str - .. py:method:: execute_agent_with_binary_data(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, blobs = None) Executes a deployed AI agent function with binary data as inputs. @@ -21117,7 +7633,6 @@ Module Contents :rtype: AgentDataExecutionResult - .. py:method:: create_batch_prediction(deployment_id, table_name = None, name = None, global_prediction_args = None, batch_prediction_args = None, explanations = False, output_format = None, output_location = None, database_connector_id = None, database_output_config = None, refresh_schedule = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, input_feature_groups = None) Creates a batch prediction job description for the given deployment. @@ -21157,7 +7672,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: start_batch_prediction(batch_prediction_id) Creates a new batch prediction version job for a given batch prediction job description. @@ -21169,7 +7683,6 @@ Module Contents :rtype: BatchPredictionVersion - .. py:method:: update_batch_prediction(batch_prediction_id, deployment_id = None, global_prediction_args = None, batch_prediction_args = None, explanations = None, output_format = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, name = None) Update a batch prediction job description. @@ -21199,7 +7712,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_file_connector_output(batch_prediction_id, output_format = None, output_location = None) Updates the file connector output configuration of the batch prediction @@ -21215,7 +7727,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_database_connector_output(batch_prediction_id, database_connector_id = None, database_output_config = None) Updates the database connector output configuration of the batch prediction @@ -21231,7 +7742,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_feature_group_output(batch_prediction_id, table_name) Creates a feature group and sets it as the batch prediction output. @@ -21245,7 +7755,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_output_to_console(batch_prediction_id) Sets the batch prediction output to the console, clearing both the file connector and database connector configurations. @@ -21257,7 +7766,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_feature_group(batch_prediction_id, feature_group_type, feature_group_id = None) Sets the batch prediction input feature group. @@ -21273,7 +7781,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_dataset_remap(batch_prediction_id, dataset_id_remap) For the purpose of this batch prediction, will swap out datasets in the training feature groups @@ -21287,7 +7794,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: delete_batch_prediction(batch_prediction_id) Deletes a batch prediction and associated data, such as associated monitors. @@ -21296,7 +7802,6 @@ Module Contents :type batch_prediction_id: str - .. py:method:: upsert_item_embeddings(streaming_token, model_id, item_id, vector, catalog_id = None) Upserts an embedding vector for an item id for a model_id. @@ -21313,7 +7818,6 @@ Module Contents :type catalog_id: str - .. py:method:: delete_item_embeddings(streaming_token, model_id, item_ids, catalog_id = None) Deletes KNN embeddings for a list of item IDs for a given model ID. @@ -21328,7 +7832,6 @@ Module Contents :type catalog_id: str - .. py:method:: upsert_multiple_item_embeddings(streaming_token, model_id, upserts, catalog_id = None) Upserts a knn embedding for multiple item ids for a model_id. @@ -21343,7 +7846,6 @@ Module Contents :type catalog_id: str - .. py:method:: append_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -21356,7 +7858,6 @@ Module Contents :type data: dict - .. py:method:: append_multiple_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -21369,7 +7870,6 @@ Module Contents :type data: list - .. py:method:: upsert_data(feature_group_id, data, streaming_token = None) Update new data into the feature group for a given lookup key record ID if the record ID is found; otherwise, insert new data into the feature group. @@ -21385,7 +7885,6 @@ Module Contents :rtype: FeatureGroupRow - .. py:method:: delete_data(feature_group_id, primary_key) Deletes a row from the feature group given the primary key @@ -21396,7 +7895,6 @@ Module Contents :type primary_key: str - .. py:method:: describe_feature_group_row_process_by_key(deployment_id, primary_key_value) Gets the feature group row process. @@ -21410,7 +7908,6 @@ Module Contents :rtype: FeatureGroupRowProcess - .. py:method:: list_feature_group_row_processes(deployment_id, limit = None, status = None) Gets a list of feature group row processes. @@ -21426,7 +7923,6 @@ Module Contents :rtype: list[FeatureGroupRowProcess] - .. py:method:: get_feature_group_row_process_summary(deployment_id) Gets a summary of the statuses of the individual feature group processes. @@ -21438,7 +7934,6 @@ Module Contents :rtype: FeatureGroupRowProcessSummary - .. py:method:: reset_feature_group_row_process_by_key(deployment_id, primary_key_value) Resets a feature group row process so that it can be reprocessed @@ -21452,7 +7947,6 @@ Module Contents :rtype: FeatureGroupRowProcess - .. py:method:: get_feature_group_row_process_logs_by_key(deployment_id, primary_key_value) Gets the logs for a feature group row process @@ -21466,7 +7960,6 @@ Module Contents :rtype: FeatureGroupRowProcessLogs - .. py:method:: create_python_function(name, source_code = None, function_name = None, function_variable_mappings = None, package_requirements = None, function_type = 'FEATURE_GROUP') Creates a custom Python function that is reusable. @@ -21488,7 +7981,6 @@ Module Contents :rtype: PythonFunction - .. py:method:: update_python_function(name, source_code = None, function_name = None, function_variable_mappings = None, package_requirements = None) Update custom python function with user inputs for the given python function. @@ -21508,7 +8000,6 @@ Module Contents :rtype: PythonFunction - .. py:method:: delete_python_function(name) Removes an existing Python function. @@ -21517,7 +8008,6 @@ Module Contents :type name: str - .. py:method:: create_pipeline(pipeline_name, project_id = None, cron = None, is_prod = None) Creates a pipeline for executing multiple steps. @@ -21535,7 +8025,6 @@ Module Contents :rtype: Pipeline - .. py:method:: describe_pipeline(pipeline_id) Describes a given pipeline. @@ -21547,7 +8036,6 @@ Module Contents :rtype: Pipeline - .. py:method:: describe_pipeline_by_name(pipeline_name) Describes a given pipeline. @@ -21559,7 +8047,6 @@ Module Contents :rtype: Pipeline - .. py:method:: update_pipeline(pipeline_id, project_id = None, pipeline_variable_mappings = None, cron = None, is_prod = None) Updates a pipeline for executing multiple steps. @@ -21579,7 +8066,6 @@ Module Contents :rtype: Pipeline - .. py:method:: rename_pipeline(pipeline_id, pipeline_name) Renames a pipeline. @@ -21593,7 +8079,6 @@ Module Contents :rtype: Pipeline - .. py:method:: delete_pipeline(pipeline_id) Deletes a pipeline. @@ -21602,7 +8087,6 @@ Module Contents :type pipeline_id: str - .. py:method:: list_pipeline_versions(pipeline_id, limit = 200) Lists the pipeline versions for a specified pipeline @@ -21616,7 +8100,6 @@ Module Contents :rtype: list[PipelineVersion] - .. py:method:: run_pipeline(pipeline_id, pipeline_variable_mappings = None) Runs a specified pipeline with the arguments provided. @@ -21630,7 +8113,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: reset_pipeline_version(pipeline_version, steps = None, include_downstream_steps = True) Reruns a pipeline version for the given steps and downstream steps if specified. @@ -21646,7 +8128,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: create_pipeline_step(pipeline_id, step_name, function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) Creates a step in a given pipeline. @@ -21678,7 +8159,6 @@ Module Contents :rtype: Pipeline - .. py:method:: delete_pipeline_step(pipeline_step_id) Deletes a step from a pipeline. @@ -21687,7 +8167,6 @@ Module Contents :type pipeline_step_id: str - .. py:method:: update_pipeline_step(pipeline_step_id, function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) Creates a step in a given pipeline. @@ -21717,7 +8196,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: rename_pipeline_step(pipeline_step_id, step_name) Renames a step in a given pipeline. @@ -21731,7 +8209,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: unset_pipeline_refresh_schedule(pipeline_id) Deletes the refresh schedule for a given pipeline. @@ -21743,7 +8220,6 @@ Module Contents :rtype: Pipeline - .. py:method:: pause_pipeline_refresh_schedule(pipeline_id) Pauses the refresh schedule for a given pipeline. @@ -21755,7 +8231,6 @@ Module Contents :rtype: Pipeline - .. py:method:: resume_pipeline_refresh_schedule(pipeline_id) Resumes the refresh schedule for a given pipeline. @@ -21767,7 +8242,6 @@ Module Contents :rtype: Pipeline - .. py:method:: skip_pending_pipeline_version_steps(pipeline_version) Skips pending steps in a pipeline version. @@ -21779,7 +8253,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: create_graph_dashboard(project_id, name, python_function_ids = None) Create a plot dashboard given selected python plots @@ -21795,7 +8268,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: delete_graph_dashboard(graph_dashboard_id) Deletes a graph dashboard @@ -21804,7 +8276,6 @@ Module Contents :type graph_dashboard_id: str - .. py:method:: update_graph_dashboard(graph_dashboard_id, name = None, python_function_ids = None) Updates a graph dashboard @@ -21820,7 +8291,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: add_graph_to_dashboard(python_function_id, graph_dashboard_id, function_variable_mappings = None, name = None) Add a python plot function to a dashboard @@ -21838,7 +8308,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: update_graph_to_dashboard(graph_reference_id, function_variable_mappings = None, name = None) Update a python plot function to a dashboard @@ -21854,7 +8323,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: delete_graph_from_dashboard(graph_reference_id) Deletes a python plot function from a dashboard @@ -21863,7 +8331,6 @@ Module Contents :type graph_reference_id: str - .. py:method:: create_algorithm(name, problem_type, source_code = None, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, config_options = None, is_default_enabled = False, project_id = None, use_gpu = False, package_requirements = None) Creates a custom algorithm that is re-usable for model training. @@ -21901,7 +8368,6 @@ Module Contents :rtype: Algorithm - .. py:method:: delete_algorithm(algorithm) Deletes the specified customer algorithm. @@ -21910,7 +8376,6 @@ Module Contents :type algorithm: str - .. py:method:: update_algorithm(algorithm, source_code = None, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, config_options = None, is_default_enabled = None, use_gpu = None, package_requirements = None) Update a custom algorithm for the given algorithm name. If source code is provided, all function names for the source code must also be provided. @@ -21944,7 +8409,6 @@ Module Contents :rtype: Algorithm - .. py:method:: list_builtin_algorithms(project_id, feature_group_ids, training_config = None) Return list of built-in algorithms based on given input data and training config. @@ -21960,7 +8424,6 @@ Module Contents :rtype: list[Algorithm] - .. py:method:: create_custom_loss_function_with_source_code(name, loss_function_type, loss_function_name, loss_function_source_code) Registers a new custom loss function which can be used as an objective function during model training. @@ -21978,7 +8441,6 @@ Module Contents :rtype: CustomLossFunction - .. py:method:: update_custom_loss_function_with_source_code(name, loss_function_name, loss_function_source_code) Updates a previously registered custom loss function with a new function implementation. @@ -21994,7 +8456,6 @@ Module Contents :rtype: CustomLossFunction - .. py:method:: delete_custom_loss_function(name) Deletes a previously registered custom loss function. @@ -22003,7 +8464,6 @@ Module Contents :type name: str - .. py:method:: create_custom_metric(name, problem_type, custom_metric_function_name = None, source_code = None) Registers a new custom metric which can be used as an evaluation metric for the trained model. @@ -22021,7 +8481,6 @@ Module Contents :rtype: CustomMetric - .. py:method:: update_custom_metric(name, custom_metric_function_name, source_code) Updates a previously registered custom metric with a new function implementation. @@ -22037,7 +8496,6 @@ Module Contents :rtype: CustomMetric - .. py:method:: delete_custom_metric(name) Deletes a previously registered custom metric. @@ -22046,7 +8504,6 @@ Module Contents :type name: str - .. py:method:: create_module(name, source_code = None) Creates a module that's re-usable in customer's code, e.g. python function, bring your own algorithm and etc. @@ -22060,7 +8517,6 @@ Module Contents :rtype: Module - .. py:method:: delete_module(name) Deletes the specified customer module. @@ -22069,7 +8525,6 @@ Module Contents :type name: str - .. py:method:: update_module(name, source_code = None) Update the module. @@ -22083,7 +8538,6 @@ Module Contents :rtype: Module - .. py:method:: create_organization_secret(secret_key, value) Creates a secret which can be accessed in functions and notebooks. @@ -22097,7 +8551,6 @@ Module Contents :rtype: OrganizationSecret - .. py:method:: delete_organization_secret(secret_key) Deletes a secret. @@ -22106,7 +8559,6 @@ Module Contents :type secret_key: str - .. py:method:: update_organization_secret(secret_key, value) Updates a secret. @@ -22120,7 +8572,6 @@ Module Contents :rtype: OrganizationSecret - .. py:method:: set_natural_language_explanation(short_explanation, long_explanation, feature_group_id = None, feature_group_version = None, model_id = None) Saves the natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version @@ -22137,7 +8588,6 @@ Module Contents :type model_id: str - .. py:method:: create_chat_session(project_id, name = None) Creates a chat session with Data Science Co-pilot. @@ -22151,7 +8601,6 @@ Module Contents :rtype: ChatSession - .. py:method:: delete_chat_message(chat_session_id, message_index) Deletes a message in a chat session and its associated response. @@ -22162,7 +8611,6 @@ Module Contents :type message_index: int - .. py:method:: export_chat_session(chat_session_id) Exports a chat session to an HTML file @@ -22171,7 +8619,6 @@ Module Contents :type chat_session_id: str - .. py:method:: rename_chat_session(chat_session_id, name) Renames a chat session with Data Science Co-pilot. @@ -22182,7 +8629,6 @@ Module Contents :type name: str - .. py:method:: suggest_abacus_apis(query, verbosity = 1, limit = 5, include_scores = False) Suggests several Abacus APIs that are most relevant to the supplied natural language query. @@ -22200,7 +8646,6 @@ Module Contents :rtype: list[AbacusApi] - .. py:method:: create_deployment_conversation(deployment_id, name, deployment_token = None, external_application_id = None) Creates a deployment conversation. @@ -22218,7 +8663,6 @@ Module Contents :rtype: DeploymentConversation - .. py:method:: delete_deployment_conversation(deployment_conversation_id, deployment_id = None, deployment_token = None) Delete a Deployment Conversation. @@ -22231,7 +8675,6 @@ Module Contents :type deployment_token: str - .. py:method:: clear_deployment_conversation(deployment_conversation_id = None, external_session_id = None, deployment_id = None, deployment_token = None, user_message_indices = None) Clear the message history of a Deployment Conversation. @@ -22248,7 +8691,6 @@ Module Contents :type user_message_indices: list - .. py:method:: set_deployment_conversation_feedback(deployment_conversation_id, message_index, is_useful = None, is_not_useful = None, feedback = None, feedback_type = None, deployment_id = None, deployment_token = None) Sets a deployment conversation message as useful or not useful @@ -22271,7 +8713,6 @@ Module Contents :type deployment_token: str - .. py:method:: rename_deployment_conversation(deployment_conversation_id, name, deployment_id = None, deployment_token = None) Rename a Deployment Conversation. @@ -22286,7 +8727,6 @@ Module Contents :type deployment_token: str - .. py:method:: create_app_user_group(name) Creates a new App User Group. This User Group is used to have permissions to access the external chatbots. @@ -22298,7 +8738,6 @@ Module Contents :rtype: AppUserGroup - .. py:method:: delete_app_user_group(user_group_id) Deletes an App User Group. @@ -22307,7 +8746,6 @@ Module Contents :type user_group_id: str - .. py:method:: invite_users_to_app_user_group(user_group_id, emails) Invite users to an App User Group. This method will send the specified email addresses an invitation link to join a specific user group. @@ -22324,7 +8762,6 @@ Module Contents :rtype: ExternalInvite - .. py:method:: add_users_to_app_user_group(user_group_id, user_emails) Adds users to a App User Group. @@ -22335,7 +8772,6 @@ Module Contents :type user_emails: list - .. py:method:: remove_users_from_app_user_group(user_group_id, user_emails) Removes users from an App User Group. @@ -22346,7 +8782,6 @@ Module Contents :type user_emails: list - .. py:method:: add_app_user_group_report_permission(user_group_id) Give the App User Group the permission to view all reports in the corresponding organization. @@ -22355,7 +8790,6 @@ Module Contents :type user_group_id: str - .. py:method:: remove_app_user_group_report_permission(user_group_id) Remove the App User Group's permission toview all reports in the corresponding organization. @@ -22364,7 +8798,6 @@ Module Contents :type user_group_id: str - .. py:method:: add_app_user_group_to_external_application(user_group_id, external_application_id) Adds a permission for an App User Group to access an External Application. @@ -22375,7 +8808,6 @@ Module Contents :type external_application_id: str - .. py:method:: remove_app_user_group_from_external_application(user_group_id, external_application_id) Removes a permission for an App User Group to access an External Application. @@ -22386,7 +8818,6 @@ Module Contents :type external_application_id: str - .. py:method:: create_external_application(deployment_id, name = None, description = None, logo = None, theme = None) Creates a new External Application from an existing ChatLLM Deployment. @@ -22406,7 +8837,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: update_external_application(external_application_id, name = None, description = None, theme = None, deployment_id = None, deployment_conversation_retention_hours = None, reset_retention_policy = False) Updates an External Application. @@ -22430,7 +8860,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: delete_external_application(external_application_id) Deletes an External Application. @@ -22439,7 +8868,6 @@ Module Contents :type external_application_id: str - .. py:method:: create_agent(project_id, function_source_code = None, agent_function_name = None, name = None, memory = None, package_requirements = None, description = None, enable_binary_input = False, evaluation_feature_group_id = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = AgentInterface.DEFAULT) Creates a new AI agent using the given agent workflow graph definition. @@ -22463,7 +8891,6 @@ Module Contents :rtype: Agent - .. py:method:: update_agent(model_id, function_source_code = None, agent_function_name = None, memory = None, package_requirements = None, description = None, enable_binary_input = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = None) Updates an existing AI Agent. A new version of the agent will be created and published. @@ -22483,7 +8910,6 @@ Module Contents :rtype: Agent - .. py:method:: evaluate_prompt(prompt = None, system_message = None, llm_name = None, max_tokens = None, temperature = 0.0, messages = None, response_type = None, json_response_schema = None) Generate response to the prompt using the specified model. @@ -22509,7 +8935,6 @@ Module Contents :rtype: LlmResponse - .. py:method:: render_feature_groups_for_llm(feature_group_ids, token_budget = None, include_definition = True) Encode feature groups as language model inputs. @@ -22522,8 +8947,7 @@ Module Contents :type include_definition: bool :returns: LLM input object comprising of information about the feature groups with given IDs. - :rtype: LlmInput - + :rtype: list[LlmInput] .. py:method:: generate_code_for_data_query_using_llm(query, feature_group_ids = None, external_database_schemas = None, prompt_context = None, llm_name = None, temperature = None, sql_dialect = 'Spark') @@ -22549,7 +8973,6 @@ Module Contents :rtype: LlmGeneratedCode - .. py:method:: extract_data_using_llm(field_descriptors, document_id = None, document_text = None, llm_name = None) Extract fields from a document using a large language model. @@ -22567,7 +8990,6 @@ Module Contents :rtype: ExtractedFields - .. py:method:: search_web_for_llm(queries, search_providers = None, max_results = 1, safe = True, fetch_content = False, max_page_tokens = 8192, convert_to_markdown = True) Access web search providers to fetch content related to the queries for use in large language model inputs. @@ -22597,7 +9019,6 @@ Module Contents :rtype: WebSearchResponse - .. py:method:: construct_agent_conversation_messages_for_llm(current_message = None, current_doc_ids = None, include_history = True, include_document_contents = True, deployment_conversation_id = None, external_session_id = None, max_document_words = None) Returns conversation history in a format for LLM calls. @@ -22621,7 +9042,6 @@ Module Contents :rtype: ChatMessage - .. py:method:: get_llm_app_response(llm_app_name, prompt) Queries the specified LLM App to generate a response to the prompt. LLM Apps are LLMs tailored to achieve a specific task like code generation for a specific service's API. @@ -22635,7 +9055,6 @@ Module Contents :rtype: LlmResponse - .. py:method:: create_document_retriever(project_id, name, feature_group_id, document_retriever_config = None) Returns a document retriever that stores embeddings for document chunks in a feature group. @@ -22656,7 +9075,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: rename_document_retriever(document_retriever_id, name) Updates an existing document retriever. @@ -22670,7 +9088,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: create_document_retriever_version(document_retriever_id, feature_group_id = None, document_retriever_config = None) Creates a document retriever version from the latest version of the feature group that the document retriever associated with. @@ -22686,7 +9103,6 @@ Module Contents :rtype: DocumentRetrieverVersion - .. py:method:: delete_document_retriever(vector_store_id) Delete a Document Retriever. @@ -22695,7 +9111,6 @@ Module Contents :type vector_store_id: str - .. py:method:: get_document_snippet(document_retriever_id, document_id, start_word_index = None, end_word_index = None) Get a snippet from documents in the document retriever. @@ -22713,7 +9128,6 @@ Module Contents :rtype: DocumentRetrieverLookupResult - .. py:method:: restart_document_retriever(document_retriever_id) Restart the document retriever if it is stopped. This will start the deployment of the document retriever, @@ -22725,7 +9139,6 @@ Module Contents :type document_retriever_id: str - .. py:method:: get_relevant_snippets(doc_ids = None, blobs = None, query = None, document_retriever_config = None, honor_sentence_boundary = True, num_retrieval_margin_words = None, max_words_per_snippet = None, max_snippets_per_document = None, start_word_index = None, end_word_index = None, including_bounding_boxes = False, text = None) Retrieves snippets relevant to a given query from specified documents. This function supports flexible input options, diff --git a/docs/_sources/autoapi/abacusai/code_source/index.rst.txt b/docs/_sources/autoapi/abacusai/code_source/index.rst.txt index 58b6ba953..3647397f8 100644 --- a/docs/_sources/autoapi/abacusai/code_source/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/code_source/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.code_source -==================== +:py:mod:`abacusai.code_source` +============================== .. py:module:: abacusai.code_source -Classes -------- - -.. autoapisummary:: - - abacusai.code_source.AbstractApiClass - abacusai.code_source.CodeSource - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.code_source.CodeSource - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Code source for python-based custom feature groups and models @@ -55,13 +45,11 @@ Module Contents :param moduleDependencies: The list of internal modules dependencies required to run the code :type moduleDependencies: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -70,7 +58,6 @@ Module Contents :rtype: dict - .. py:method:: import_as_cell() Adds the source code as an unexecuted cell in the notebook. diff --git a/docs/_sources/autoapi/abacusai/concatenation_config/index.rst.txt b/docs/_sources/autoapi/abacusai/concatenation_config/index.rst.txt index 31ff4b1c7..84cd5eb6c 100644 --- a/docs/_sources/autoapi/abacusai/concatenation_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/concatenation_config/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.concatenation_config -============================= +:py:mod:`abacusai.concatenation_config` +======================================= .. py:module:: abacusai.concatenation_config -Classes -------- - -.. autoapisummary:: - - abacusai.concatenation_config.AbstractApiClass - abacusai.concatenation_config.ConcatenationConfig - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.concatenation_config.ConcatenationConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ConcatenationConfig(client, concatenatedTable=None, mergeType=None, replaceUntilTimestamp=None, skipMaterialize=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Feature Group Concatenation Config @@ -45,13 +35,11 @@ Module Contents :param skipMaterialize: If `True`, the concatenated feature group will not be materialized. :type skipMaterialize: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/cpu_gpu_memory_specs/index.rst.txt b/docs/_sources/autoapi/abacusai/cpu_gpu_memory_specs/index.rst.txt index 579f30278..b484ee803 100644 --- a/docs/_sources/autoapi/abacusai/cpu_gpu_memory_specs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/cpu_gpu_memory_specs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.cpu_gpu_memory_specs -============================= +:py:mod:`abacusai.cpu_gpu_memory_specs` +======================================= .. py:module:: abacusai.cpu_gpu_memory_specs -Classes -------- - -.. autoapisummary:: - - abacusai.cpu_gpu_memory_specs.AbstractApiClass - abacusai.cpu_gpu_memory_specs.CpuGpuMemorySpecs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.cpu_gpu_memory_specs.CpuGpuMemorySpecs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CpuGpuMemorySpecs(client, default=None, data=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Includes the memory specs of the CPU/GPU @@ -41,13 +31,11 @@ Module Contents :param data: the list of memory sizes for the processing unit :type data: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/cryptography/index.rst.txt b/docs/_sources/autoapi/abacusai/cryptography/index.rst.txt index 05a69064e..a9bfdbc23 100644 --- a/docs/_sources/autoapi/abacusai/cryptography/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/cryptography/index.rst.txt @@ -1,11 +1,15 @@ -abacusai.cryptography -===================== +:py:mod:`abacusai.cryptography` +=============================== .. py:module:: abacusai.cryptography +Module Contents +--------------- + + Functions ---------- +~~~~~~~~~ .. autoapisummary:: @@ -13,8 +17,6 @@ Functions abacusai.cryptography.get_public_key -Module Contents ---------------- .. py:function:: verify_response(public_key, response) diff --git a/docs/_sources/autoapi/abacusai/custom_loss_function/index.rst.txt b/docs/_sources/autoapi/abacusai/custom_loss_function/index.rst.txt index 921bb5798..551ee5bf8 100644 --- a/docs/_sources/autoapi/abacusai/custom_loss_function/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/custom_loss_function/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.custom_loss_function -============================= +:py:mod:`abacusai.custom_loss_function` +======================================= .. py:module:: abacusai.custom_loss_function -Classes -------- - -.. autoapisummary:: - - abacusai.custom_loss_function.CodeSource - abacusai.custom_loss_function.AbstractApiClass - abacusai.custom_loss_function.CustomLossFunction - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.custom_loss_function.CustomLossFunction - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CustomLossFunction(client, notebookId=None, name=None, createdAt=None, lossFunctionName=None, lossFunctionType=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Custom Loss Function @@ -100,13 +39,11 @@ Module Contents :param codeSource: Information about the source code of the loss function. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/custom_metric/index.rst.txt b/docs/_sources/autoapi/abacusai/custom_metric/index.rst.txt index 5ea14b1a7..50c09d8c5 100644 --- a/docs/_sources/autoapi/abacusai/custom_metric/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/custom_metric/index.rst.txt @@ -1,94 +1,26 @@ -abacusai.custom_metric -====================== +:py:mod:`abacusai.custom_metric` +================================ .. py:module:: abacusai.custom_metric -Classes -------- - -.. autoapisummary:: - - abacusai.custom_metric.CustomMetricVersion - abacusai.custom_metric.AbstractApiClass - abacusai.custom_metric.CustomMetric - - Module Contents --------------- -.. py:class:: CustomMetricVersion(client, customMetricVersion=None, name=None, createdAt=None, customMetricFunctionName=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Custom metric version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param customMetricVersion: Unique string identifier for the custom metric version. - :type customMetricVersion: str - :param name: Name assigned to the custom metric. - :type name: str - :param createdAt: ISO-8601 string indicating when the custom metric was created. - :type createdAt: str - :param customMetricFunctionName: The name of the function defined in the source code. - :type customMetricFunctionName: str - :param codeSource: Information about the source code of the custom metric. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: CustomMetricVersion - - - - .. py:method:: describe() - - Describes a given custom metric version - - :param custom_metric_version: A unique string identifier for the custom metric version. - :type custom_metric_version: str - - :returns: An object describing the custom metric version. - :rtype: CustomMetricVersion - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.custom_metric.CustomMetric - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CustomMetric(client, customMetricId=None, name=None, createdAt=None, problemType=None, notebookId=None, latestCustomMetricVersion={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Custom metric. @@ -107,13 +39,11 @@ Module Contents :param latestCustomMetricVersion: Latest version of the custom metric. :type latestCustomMetricVersion: CustomMetricVersion - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/custom_metric_version/index.rst.txt b/docs/_sources/autoapi/abacusai/custom_metric_version/index.rst.txt index bd90fcc06..6789da17a 100644 --- a/docs/_sources/autoapi/abacusai/custom_metric_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/custom_metric_version/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.custom_metric_version -============================== +:py:mod:`abacusai.custom_metric_version` +======================================== .. py:module:: abacusai.custom_metric_version -Classes -------- - -.. autoapisummary:: - - abacusai.custom_metric_version.CodeSource - abacusai.custom_metric_version.AbstractApiClass - abacusai.custom_metric_version.CustomMetricVersion - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.custom_metric_version.CustomMetricVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CustomMetricVersion(client, customMetricVersion=None, name=None, createdAt=None, customMetricFunctionName=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Custom metric version @@ -98,13 +37,11 @@ Module Contents :param codeSource: Information about the source code of the custom metric. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -113,7 +50,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -122,7 +58,6 @@ Module Contents :rtype: CustomMetricVersion - .. py:method:: describe() Describes a given custom metric version diff --git a/docs/_sources/autoapi/abacusai/custom_train_function_info/index.rst.txt b/docs/_sources/autoapi/abacusai/custom_train_function_info/index.rst.txt index 86e9c275b..25638ea8b 100644 --- a/docs/_sources/autoapi/abacusai/custom_train_function_info/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/custom_train_function_info/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.custom_train_function_info -=================================== +:py:mod:`abacusai.custom_train_function_info` +============================================= .. py:module:: abacusai.custom_train_function_info -Classes -------- - -.. autoapisummary:: - - abacusai.custom_train_function_info.AbstractApiClass - abacusai.custom_train_function_info.CustomTrainFunctionInfo - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.custom_train_function_info.CustomTrainFunctionInfo - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: CustomTrainFunctionInfo(client, trainingDataParameterNameMapping=None, schemaMappings=None, trainDataParameterToFeatureGroupIds=None, trainingConfig=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Information about how to call the customer provided train function. @@ -45,13 +35,11 @@ Module Contents :param trainingConfig: The configs for training :type trainingConfig: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/data_consistency_duplication/index.rst.txt b/docs/_sources/autoapi/abacusai/data_consistency_duplication/index.rst.txt index 7b31d27d5..efb3d9975 100644 --- a/docs/_sources/autoapi/abacusai/data_consistency_duplication/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/data_consistency_duplication/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.data_consistency_duplication -===================================== +:py:mod:`abacusai.data_consistency_duplication` +=============================================== .. py:module:: abacusai.data_consistency_duplication -Classes -------- - -.. autoapisummary:: - - abacusai.data_consistency_duplication.AbstractApiClass - abacusai.data_consistency_duplication.DataConsistencyDuplication - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.data_consistency_duplication.DataConsistencyDuplication - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DataConsistencyDuplication(client, totalCount=None, numDuplicates=None, sample={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Data Consistency for duplication within data @@ -43,13 +33,11 @@ Module Contents :param sample: A list of dicts enumerating rows the rows that contained duplications in primary keys. :type sample: FeatureRecord - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/data_metrics/index.rst.txt b/docs/_sources/autoapi/abacusai/data_metrics/index.rst.txt index 3037458d1..06df28237 100644 --- a/docs/_sources/autoapi/abacusai/data_metrics/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/data_metrics/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.data_metrics -===================== +:py:mod:`abacusai.data_metrics` +=============================== .. py:module:: abacusai.data_metrics -Classes -------- - -.. autoapisummary:: - - abacusai.data_metrics.AbstractApiClass - abacusai.data_metrics.DataMetrics - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.data_metrics.DataMetrics - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DataMetrics(client, metrics=None, schema=None, numRows=None, numCols=None, numDuplicateRows=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Processed Metrics and Schema for a dataset version or feature group version @@ -47,13 +37,11 @@ Module Contents :param numDuplicateRows: The number of duplicate rows :type numDuplicateRows: int - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/data_prep_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/data_prep_logs/index.rst.txt index db54d7ba7..5d252279e 100644 --- a/docs/_sources/autoapi/abacusai/data_prep_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/data_prep_logs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.data_prep_logs -======================= +:py:mod:`abacusai.data_prep_logs` +================================= .. py:module:: abacusai.data_prep_logs -Classes -------- - -.. autoapisummary:: - - abacusai.data_prep_logs.AbstractApiClass - abacusai.data_prep_logs.DataPrepLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.data_prep_logs.DataPrepLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DataPrepLogs(client, logs=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs from data preparation. @@ -39,13 +29,11 @@ Module Contents :param logs: List of logs from data preparation during model training. :type logs: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/data_quality_results/index.rst.txt b/docs/_sources/autoapi/abacusai/data_quality_results/index.rst.txt index 62180f8b3..fba03572d 100644 --- a/docs/_sources/autoapi/abacusai/data_quality_results/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/data_quality_results/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.data_quality_results -============================= +:py:mod:`abacusai.data_quality_results` +======================================= .. py:module:: abacusai.data_quality_results -Classes -------- - -.. autoapisummary:: - - abacusai.data_quality_results.AbstractApiClass - abacusai.data_quality_results.DataQualityResults - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.data_quality_results.DataQualityResults - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DataQualityResults(client, results=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Data Quality results from normalization stage @@ -39,13 +29,11 @@ Module Contents :param results: A list with different pairs of quality parameters and their values :type results: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/data_upload_result/index.rst.txt b/docs/_sources/autoapi/abacusai/data_upload_result/index.rst.txt index 11133e999..ffb869d42 100644 --- a/docs/_sources/autoapi/abacusai/data_upload_result/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/data_upload_result/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.data_upload_result -=========================== +:py:mod:`abacusai.data_upload_result` +===================================== .. py:module:: abacusai.data_upload_result -Classes -------- - -.. autoapisummary:: - - abacusai.data_upload_result.AbstractApiClass - abacusai.data_upload_result.DataUploadResult - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.data_upload_result.DataUploadResult - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DataUploadResult(client, docInfos=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Results of uploading data to agent. @@ -39,13 +29,11 @@ Module Contents :param docInfos: A list of dict for information on the documents uploaded to agent. :type docInfos: list[agentdatadocumentinfo] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/database_column_feature_mapping/index.rst.txt b/docs/_sources/autoapi/abacusai/database_column_feature_mapping/index.rst.txt index a7e9ee86f..6be3bbba6 100644 --- a/docs/_sources/autoapi/abacusai/database_column_feature_mapping/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/database_column_feature_mapping/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.database_column_feature_mapping -======================================== +:py:mod:`abacusai.database_column_feature_mapping` +================================================== .. py:module:: abacusai.database_column_feature_mapping -Classes -------- - -.. autoapisummary:: - - abacusai.database_column_feature_mapping.AbstractApiClass - abacusai.database_column_feature_mapping.DatabaseColumnFeatureMapping - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.database_column_feature_mapping.DatabaseColumnFeatureMapping - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatabaseColumnFeatureMapping(client, databaseColumn=None, feature=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Mapping for export of feature group version to database column @@ -41,13 +31,11 @@ Module Contents :param feature: feature group column it has been matched to :type feature: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/database_connector/index.rst.txt b/docs/_sources/autoapi/abacusai/database_connector/index.rst.txt index 643fe11ec..2fd601489 100644 --- a/docs/_sources/autoapi/abacusai/database_connector/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/database_connector/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.database_connector -=========================== +:py:mod:`abacusai.database_connector` +===================================== .. py:module:: abacusai.database_connector -Classes -------- - -.. autoapisummary:: - - abacusai.database_connector.AbstractApiClass - abacusai.database_connector.DatabaseConnector - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.database_connector.DatabaseConnector - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatabaseConnector(client, databaseConnectorId=None, service=None, name=None, status=None, auth=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A connector to an external service @@ -49,13 +39,11 @@ Module Contents :param createdAt: The ISO-8601 string indicating when the API key was created. :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -64,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: list_objects(fetch_raw_data = False) Lists querable objects in the database connector. @@ -73,7 +60,6 @@ Module Contents :type fetch_raw_data: bool - .. py:method:: get_object_schema(object_name = None, fetch_raw_data = False) Get the schema of an object in an database connector. @@ -87,7 +73,6 @@ Module Contents :rtype: DatabaseConnectorSchema - .. py:method:: rename(name) Renames a Database Connector @@ -96,7 +81,6 @@ Module Contents :type name: str - .. py:method:: verify() Checks if Abacus.AI can access the specified database. @@ -105,7 +89,6 @@ Module Contents :type database_connector_id: str - .. py:method:: delete() Delete a database connector. @@ -114,7 +97,6 @@ Module Contents :type database_connector_id: str - .. py:method:: query(query) Runs a query in the specified database connector. diff --git a/docs/_sources/autoapi/abacusai/database_connector_column/index.rst.txt b/docs/_sources/autoapi/abacusai/database_connector_column/index.rst.txt index 1a3520fdf..3d61d2321 100644 --- a/docs/_sources/autoapi/abacusai/database_connector_column/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/database_connector_column/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.database_connector_column -================================== +:py:mod:`abacusai.database_connector_column` +============================================ .. py:module:: abacusai.database_connector_column -Classes -------- - -.. autoapisummary:: - - abacusai.database_connector_column.AbstractApiClass - abacusai.database_connector_column.DatabaseConnectorColumn - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.database_connector_column.DatabaseConnectorColumn - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatabaseConnectorColumn(client, name=None, externalDataType=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A schema description for a column from a database connector @@ -41,13 +31,11 @@ Module Contents :param externalDataType: The data type of column in the external database system. :type externalDataType: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/database_connector_schema/index.rst.txt b/docs/_sources/autoapi/abacusai/database_connector_schema/index.rst.txt index 58949e071..d171bbb69 100644 --- a/docs/_sources/autoapi/abacusai/database_connector_schema/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/database_connector_schema/index.rst.txt @@ -1,67 +1,26 @@ -abacusai.database_connector_schema -================================== +:py:mod:`abacusai.database_connector_schema` +============================================ .. py:module:: abacusai.database_connector_schema -Classes -------- - -.. autoapisummary:: - - abacusai.database_connector_schema.DatabaseConnectorColumn - abacusai.database_connector_schema.AbstractApiClass - abacusai.database_connector_schema.DatabaseConnectorSchema - - Module Contents --------------- -.. py:class:: DatabaseConnectorColumn(client, name=None, externalDataType=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a column from a database connector - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column. - :type name: str - :param externalDataType: The data type of column in the external database system. - :type externalDataType: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.database_connector_schema.DatabaseConnectorSchema - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatabaseConnectorSchema(client, tableName=None, columns={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A schema description for a table from a database connector @@ -72,13 +31,11 @@ Module Contents :param columns: List of columns in the table. :type columns: DatabaseConnectorColumn - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/dataset/index.rst.txt b/docs/_sources/autoapi/abacusai/dataset/index.rst.txt index 9e95a6823..f5ff8b0a1 100644 --- a/docs/_sources/autoapi/abacusai/dataset/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/dataset/index.rst.txt @@ -1,440 +1,26 @@ -abacusai.dataset -================ +:py:mod:`abacusai.dataset` +========================== .. py:module:: abacusai.dataset -Classes -------- - -.. autoapisummary:: - - abacusai.dataset.ApplicationConnectorDatasetConfig - abacusai.dataset.DatasetDocumentProcessingConfig - abacusai.dataset.DataType - abacusai.dataset.DocumentProcessingConfig - abacusai.dataset.ParsingConfig - abacusai.dataset.DatasetColumn - abacusai.dataset.DatasetVersion - abacusai.dataset.RefreshSchedule - abacusai.dataset.AbstractApiClass - abacusai.dataset.Dataset - - Module Contents --------------- -.. py:class:: ApplicationConnectorDatasetConfig - - Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` - - - An abstract class for dataset configs specific to application connectors. - - :param application_connector_type: The type of application connector - :type application_connector_type: enums.ApplicationConnectorType - - - .. py:attribute:: application_connector_type - :type: abacusai.api_class.enums.ApplicationConnectorType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: DatasetDocumentProcessingConfig - - Bases: :py:obj:`DocumentProcessingConfig` - - - Document processing configuration for dataset imports. - - :param extract_bounding_boxes: Whether to perform OCR and extract bounding boxes. If False, no OCR will be done but only the embedded text from digital documents will be extracted. Defaults to False. - :type extract_bounding_boxes: bool - :param ocr_mode: OCR mode. There are different OCR modes available for different kinds of documents and use cases. This option only takes effect when extract_bounding_boxes is True. - :type ocr_mode: OcrMode - :param use_full_ocr: Whether to perform full OCR. If True, OCR will be performed on the full page. If False, OCR will be performed on the non-text regions only. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type use_full_ocr: bool - :param remove_header_footer: Whether to remove headers and footers. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type remove_header_footer: bool - :param remove_watermarks: Whether to remove watermarks. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type remove_watermarks: bool - :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type convert_to_markdown: bool - :param page_text_column: Name of the output column which contains the extracted text for each page. If not provided, no column will be created. - :type page_text_column: str - - - .. py:attribute:: page_text_column - :type: str - :value: None - - - -.. py:class:: DataType - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: INTEGER - :value: 'integer' - - - - .. py:attribute:: FLOAT - :value: 'float' - - - - .. py:attribute:: STRING - :value: 'string' - - - - .. py:attribute:: DATE - :value: 'date' - - - - .. py:attribute:: DATETIME - :value: 'datetime' - - - - .. py:attribute:: BOOLEAN - :value: 'boolean' - - - - .. py:attribute:: LIST - :value: 'list' - - - - .. py:attribute:: STRUCT - :value: 'struct' - - - - .. py:attribute:: NULL - :value: 'null' - - - -.. py:class:: DocumentProcessingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Document processing configuration. - - :param extract_bounding_boxes: Whether to perform OCR and extract bounding boxes. If False, no OCR will be done but only the embedded text from digital documents will be extracted. Defaults to False. - :type extract_bounding_boxes: bool - :param ocr_mode: OCR mode. There are different OCR modes available for different kinds of documents and use cases. This option only takes effect when extract_bounding_boxes is True. - :type ocr_mode: OcrMode - :param use_full_ocr: Whether to perform full OCR. If True, OCR will be performed on the full page. If False, OCR will be performed on the non-text regions only. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type use_full_ocr: bool - :param remove_header_footer: Whether to remove headers and footers. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type remove_header_footer: bool - :param remove_watermarks: Whether to remove watermarks. By default, it will be decided automatically based on the OCR mode and the document type. This option only takes effect when extract_bounding_boxes is True. - :type remove_watermarks: bool - :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. - :type convert_to_markdown: bool - - - .. py:attribute:: extract_bounding_boxes - :type: bool - :value: False - - - - .. py:attribute:: ocr_mode - :type: abacusai.api_class.enums.OcrMode - - - .. py:attribute:: use_full_ocr - :type: bool - :value: None - - - - .. py:attribute:: remove_header_footer - :type: bool - :value: False - - - - .. py:attribute:: remove_watermarks - :type: bool - :value: True - - - - .. py:attribute:: convert_to_markdown - :type: bool - :value: False - - - -.. py:class:: ParsingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Custom config for dataset parsing. - - :param escape: Escape character for CSV files. Defaults to '"'. - :type escape: str - :param csv_delimiter: Delimiter for CSV files. Defaults to None. - :type csv_delimiter: str - :param file_path_with_schema: Path to the file with schema. Defaults to None. - :type file_path_with_schema: str - - - .. py:attribute:: escape - :type: str - - - .. py:attribute:: csv_delimiter - :type: str - - - .. py:attribute:: file_path_with_schema - :type: str - - -.. py:class:: DatasetColumn(client, name=None, dataType=None, detectedDataType=None, featureType=None, detectedFeatureType=None, originalName=None, validDataTypes=None, timeFormat=None, timestampFrequency=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a column - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column. - :type name: str - :param dataType: The underlying data type of each column. - :type dataType: str - :param detectedDataType: The detected data type of the column. - :type detectedDataType: str - :param featureType: Feature type of the column. - :type featureType: str - :param detectedFeatureType: The detected feature type of the column. - :type detectedFeatureType: str - :param originalName: The original name of the column. - :type originalName: str - :param validDataTypes: The valid data type options for this column. - :type validDataTypes: list[str] - :param timeFormat: The detected time format of the column. - :type timeFormat: str - :param timestampFrequency: The detected frequency of the timestamps in the dataset. - :type timestampFrequency: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DatasetVersion(client, datasetVersion=None, status=None, datasetId=None, size=None, rowCount=None, fileInspectMetadata=None, createdAt=None, error=None, incrementalQueriedAt=None, uploadId=None, mergeFileSchemas=None, databaseConnectorConfig=None, applicationConnectorConfig=None, invalidRecords=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A specific version of a dataset - - :param client: An authenticated API Client instance - :type client: ApiClient - :param datasetVersion: The unique identifier of the dataset version. - :type datasetVersion: str - :param status: The current status of the dataset version - :type status: str - :param datasetId: A reference to the Dataset this dataset version belongs to. - :type datasetId: str - :param size: The size in bytes of the file. - :type size: int - :param rowCount: Number of rows in the dataset version. - :type rowCount: int - :param fileInspectMetadata: Metadata information about file's inspection. For example - the detected delimiter for CSV files. - :type fileInspectMetadata: dict - :param createdAt: The timestamp this dataset version was created. - :type createdAt: str - :param error: If status is FAILED, this field will be populated with an error. - :type error: str - :param incrementalQueriedAt: If the dataset version is from an incremental dataset, this is the last entry of timestamp column when the dataset version was created. - :type incrementalQueriedAt: str - :param uploadId: If the dataset version is being uploaded, this the reference to the Upload - :type uploadId: str - :param mergeFileSchemas: If the merge file schemas policy is enabled. - :type mergeFileSchemas: bool - :param databaseConnectorConfig: The database connector query used to retrieve data for this version. - :type databaseConnectorConfig: dict - :param applicationConnectorConfig: The application connector used to retrieve data for this version. - :type applicationConnectorConfig: dict - :param invalidRecords: Invalid records in the dataset version - :type invalidRecords: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) - - Get metrics for a specific dataset version. - - :param selected_columns: A list of columns to order first. - :type selected_columns: List - :param include_charts: A flag indicating whether charts should be included in the response. Default is false. - :type include_charts: bool - :param include_statistics: A flag indicating whether statistics should be included in the response. Default is true. - :type include_statistics: bool - - :returns: The metrics for the specified Dataset version. - :rtype: DataMetrics - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DatasetVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified dataset version, including its ID, name, source type, and other attributes. - - :param dataset_version: Unique string identifier associated with the dataset version. - :type dataset_version: str - - :returns: The dataset version. - :rtype: DatasetVersion - - - - .. py:method:: get_logs() - - Retrieves the dataset import logs. - - :param dataset_version: The unique version ID of the dataset version. - :type dataset_version: str - - :returns: The logs for the specified dataset version. - :rtype: DatasetVersionLogs - - - - .. py:method:: wait_for_import(timeout=900) - - A waiting call until dataset version is imported. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_inspection(timeout=None) - - A waiting call until dataset version is completely inspected. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the dataset version. - - :returns: A string describing the status of a dataset version (importing, inspecting, complete, etc.). - :rtype: str - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.dataset.Dataset - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Dataset(client, datasetId=None, sourceType=None, dataSource=None, createdAt=None, ignoreBefore=None, ephemeral=None, lookbackDays=None, databaseConnectorId=None, databaseConnectorConfig=None, connectorType=None, featureGroupTableName=None, applicationConnectorId=None, applicationConnectorConfig=None, incremental=None, isDocumentset=None, extractBoundingBoxes=None, mergeFileSchemas=None, referenceOnlyDocumentset=None, schema={}, refreshSchedules={}, latestDatasetVersion={}, parsingConfig={}, documentProcessingConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A dataset reference @@ -487,13 +73,11 @@ Module Contents :param documentProcessingConfig: The document processing config used for dataset (when is_documentset is True). :type documentProcessingConfig: DocumentProcessingConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -502,7 +86,6 @@ Module Contents :rtype: dict - .. py:method:: create_version_from_file_connector(location = None, file_format = None, csv_delimiter = None, merge_file_schemas = None, parsing_config = None) Creates a new version of the specified dataset. @@ -522,7 +105,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_version_from_database_connector(object_name = None, columns = None, query_arguments = None, sql_query = None) Creates a new version of the specified dataset. @@ -540,7 +122,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_version_from_application_connector(dataset_config = None) Creates a new version of the specified dataset. @@ -552,7 +133,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: create_version_from_upload(file_format = None) Creates a new version of the specified dataset using a local file upload. @@ -564,7 +144,6 @@ Module Contents :rtype: Upload - .. py:method:: create_version_from_document_reprocessing(document_processing_config = None) Creates a new dataset version for a source docstore dataset with the provided document processing configuration. This does not re-import the data but uses the same data which is imported in the latest dataset version and only performs document processing on it. @@ -576,7 +155,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: snapshot_streaming_data() Snapshots the current data in the streaming dataset. @@ -588,7 +166,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: set_column_data_type(column, data_type) Set a Dataset's column type. @@ -602,7 +179,6 @@ Module Contents :rtype: Dataset - .. py:method:: set_streaming_retention_policy(retention_hours = None, retention_row_count = None, ignore_records_before_timestamp = None) Sets the streaming retention policy. @@ -615,7 +191,6 @@ Module Contents :type ignore_records_before_timestamp: int - .. py:method:: get_schema() Retrieves the column schema of a dataset. @@ -627,7 +202,6 @@ Module Contents :rtype: list[DatasetColumn] - .. py:method:: set_database_connector_config(database_connector_id, object_name = None, columns = None, query_arguments = None, sql_query = None) Sets database connector config for a dataset. This method is currently only supported for streaming datasets. @@ -644,7 +218,6 @@ Module Contents :type sql_query: str - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -653,7 +226,6 @@ Module Contents :rtype: Dataset - .. py:method:: describe() Retrieves a full description of the specified dataset, with attributes such as its ID, name, source type, etc. @@ -665,7 +237,6 @@ Module Contents :rtype: Dataset - .. py:method:: list_versions(limit = 100, start_after_version = None) Retrieves a list of all dataset versions for the specified dataset. @@ -679,7 +250,6 @@ Module Contents :rtype: list[DatasetVersion] - .. py:method:: delete() Deletes the specified dataset from the organization. @@ -688,7 +258,6 @@ Module Contents :type dataset_id: str - .. py:method:: wait_for_import(timeout=900) A waiting call until dataset is imported. @@ -697,7 +266,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_inspection(timeout=None) A waiting call until dataset is completely inspected. @@ -706,7 +274,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the latest dataset version. @@ -715,7 +282,6 @@ Module Contents :rtype: str - .. py:method:: describe_feature_group() Gets the feature group attached to the dataset. @@ -724,7 +290,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_refresh_policy(cron) To create a refresh policy for a dataset. @@ -736,7 +301,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: list_refresh_policies() Gets the refresh policies in a list. diff --git a/docs/_sources/autoapi/abacusai/dataset_column/index.rst.txt b/docs/_sources/autoapi/abacusai/dataset_column/index.rst.txt index 671113253..498a9b05e 100644 --- a/docs/_sources/autoapi/abacusai/dataset_column/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/dataset_column/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.dataset_column -======================= +:py:mod:`abacusai.dataset_column` +================================= .. py:module:: abacusai.dataset_column -Classes -------- - -.. autoapisummary:: - - abacusai.dataset_column.AbstractApiClass - abacusai.dataset_column.DatasetColumn - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.dataset_column.DatasetColumn - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatasetColumn(client, name=None, dataType=None, detectedDataType=None, featureType=None, detectedFeatureType=None, originalName=None, validDataTypes=None, timeFormat=None, timestampFrequency=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A schema description for a column @@ -55,13 +45,11 @@ Module Contents :param timestampFrequency: The detected frequency of the timestamps in the dataset. :type timestampFrequency: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/dataset_version/index.rst.txt b/docs/_sources/autoapi/abacusai/dataset_version/index.rst.txt index 29aa75bb3..e4f795786 100644 --- a/docs/_sources/autoapi/abacusai/dataset_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/dataset_version/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.dataset_version -======================== +:py:mod:`abacusai.dataset_version` +================================== .. py:module:: abacusai.dataset_version -Classes -------- - -.. autoapisummary:: - - abacusai.dataset_version.AbstractApiClass - abacusai.dataset_version.DatasetVersion - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.dataset_version.DatasetVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatasetVersion(client, datasetVersion=None, status=None, datasetId=None, size=None, rowCount=None, fileInspectMetadata=None, createdAt=None, error=None, incrementalQueriedAt=None, uploadId=None, mergeFileSchemas=None, databaseConnectorConfig=None, applicationConnectorConfig=None, invalidRecords=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A specific version of a dataset @@ -65,13 +55,11 @@ Module Contents :param invalidRecords: Invalid records in the dataset version :type invalidRecords: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -80,7 +68,6 @@ Module Contents :rtype: dict - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) Get metrics for a specific dataset version. @@ -96,7 +83,6 @@ Module Contents :rtype: DataMetrics - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -105,7 +91,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: describe() Retrieves a full description of the specified dataset version, including its ID, name, source type, and other attributes. @@ -117,7 +102,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: get_logs() Retrieves the dataset import logs. @@ -129,7 +113,6 @@ Module Contents :rtype: DatasetVersionLogs - .. py:method:: wait_for_import(timeout=900) A waiting call until dataset version is imported. @@ -138,7 +121,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_inspection(timeout=None) A waiting call until dataset version is completely inspected. @@ -147,7 +129,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the dataset version. diff --git a/docs/_sources/autoapi/abacusai/dataset_version_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/dataset_version_logs/index.rst.txt index 113c695ff..9873e1e6b 100644 --- a/docs/_sources/autoapi/abacusai/dataset_version_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/dataset_version_logs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.dataset_version_logs -============================= +:py:mod:`abacusai.dataset_version_logs` +======================================= .. py:module:: abacusai.dataset_version_logs -Classes -------- - -.. autoapisummary:: - - abacusai.dataset_version_logs.AbstractApiClass - abacusai.dataset_version_logs.DatasetVersionLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.dataset_version_logs.DatasetVersionLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DatasetVersionLogs(client, logs=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs from dataset version. @@ -39,13 +29,11 @@ Module Contents :param logs: List of logs from dataset version. :type logs: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/deployment/index.rst.txt b/docs/_sources/autoapi/abacusai/deployment/index.rst.txt index 8d3a06837..ef2547fdc 100644 --- a/docs/_sources/autoapi/abacusai/deployment/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/deployment/index.rst.txt @@ -1,204 +1,26 @@ -abacusai.deployment -=================== +:py:mod:`abacusai.deployment` +============================= .. py:module:: abacusai.deployment -Classes -------- - -.. autoapisummary:: - - abacusai.deployment.AlertActionConfig - abacusai.deployment.AlertConditionConfig - abacusai.deployment.BatchPredictionArgs - abacusai.deployment.PredictionArguments - abacusai.deployment.FeatureGroupExportConfig - abacusai.deployment.RefreshSchedule - abacusai.deployment.AbstractApiClass - abacusai.deployment.Deployment - - Module Contents --------------- -.. py:class:: AlertActionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert action configs - - - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: AlertConditionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert condition configs - - - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: BatchPredictionArgs - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for Batch Prediction args specific to problem type. - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: PredictionArguments - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for prediction arguments specific to problem type. - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: FeatureGroupExportConfig(client, outputLocation=None, fileFormat=None, databaseConnectorId=None, objectName=None, writeMode=None, databaseFeatureMapping=None, idColumn=None, additionalIdColumns=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Export configuration (file connector or database connector information) for feature group exports. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param outputLocation: The File Connector location to which the feature group is being written. - :type outputLocation: str - :param fileFormat: The file format being written to output_location. - :type fileFormat: str - :param databaseConnectorId: The unique string identifier of the database connector used. - :type databaseConnectorId: str - :param objectName: The object in the database connector to which the feature group is being written. - :type objectName: str - :param writeMode: UPSERT or INSERT for writing to the database connector. - :type writeMode: str - :param databaseFeatureMapping: The column/feature pairs mapping the features to the database columns. - :type databaseFeatureMapping: dict - :param idColumn: The id column to use as the upsert key. - :type idColumn: str - :param additionalIdColumns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additionalIdColumns: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.deployment.Deployment - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Deployment(client, deploymentId=None, name=None, status=None, description=None, deployedAt=None, createdAt=None, projectId=None, modelId=None, modelVersion=None, featureGroupId=None, featureGroupVersion=None, callsPerSecond=None, autoDeploy=None, skipMetricsCheck=None, algoName=None, regions=None, error=None, batchStreamingUpdates=None, algorithm=None, pendingModelVersion=None, modelDeploymentConfig=None, predictionOperatorId=None, predictionOperatorVersion=None, pendingPredictionOperatorVersion=None, onlineFeatureGroupId=None, outputOnlineFeatureGroupId=None, realtimeMonitorId=None, refreshSchedules={}, featureGroupExportConfig={}, defaultPredictionArguments={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A model deployment @@ -265,13 +87,11 @@ Module Contents :param defaultPredictionArguments: The default prediction arguments for prediction APIs :type defaultPredictionArguments: PredictionArguments - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -280,7 +100,6 @@ Module Contents :rtype: dict - .. py:method:: create_webhook(endpoint, webhook_event_type, payload_template = None) Create a webhook attached to a given deployment ID. @@ -296,7 +115,6 @@ Module Contents :rtype: Webhook - .. py:method:: list_webhooks() List all the webhooks attached to a given deployment. @@ -308,7 +126,6 @@ Module Contents :rtype: list[Webhook] - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -317,7 +134,6 @@ Module Contents :rtype: Deployment - .. py:method:: describe() Retrieves a full description of the specified deployment. @@ -329,7 +145,6 @@ Module Contents :rtype: Deployment - .. py:method:: update(description = None, auto_deploy = None, skip_metrics_check = None) Updates a deployment's properties. @@ -342,7 +157,6 @@ Module Contents :type skip_metrics_check: bool - .. py:method:: rename(name) Updates a deployment's name @@ -351,7 +165,6 @@ Module Contents :type name: str - .. py:method:: set_auto(enable = None) Enable or disable auto deployment for the specified deployment. @@ -363,7 +176,6 @@ Module Contents :type enable: bool - .. py:method:: set_model_version(model_version, algorithm = None, model_deployment_config = None) Promotes a model version and/or algorithm to be the active served deployment version @@ -376,7 +188,6 @@ Module Contents :type model_deployment_config: dict - .. py:method:: set_feature_group_version(feature_group_version) Promotes a feature group version to be served in the deployment. @@ -385,7 +196,6 @@ Module Contents :type feature_group_version: str - .. py:method:: set_prediction_operator_version(prediction_operator_version) Promotes a prediction operator version to be served in the deployment. @@ -394,7 +204,6 @@ Module Contents :type prediction_operator_version: str - .. py:method:: start() Restarts the specified deployment that was previously suspended. @@ -403,7 +212,6 @@ Module Contents :type deployment_id: str - .. py:method:: stop() Stops the specified deployment. @@ -412,7 +220,6 @@ Module Contents :type deployment_id: str - .. py:method:: delete() Deletes the specified deployment. The deployment's models will not be affected. Note that the deployments are not recoverable after they are deleted. @@ -421,7 +228,6 @@ Module Contents :type deployment_id: str - .. py:method:: set_feature_group_export_file_connector_output(file_format = None, output_location = None) Sets the export output for the Feature Group Deployment to be a file connector. @@ -432,7 +238,6 @@ Module Contents :type output_location: str - .. py:method:: set_feature_group_export_database_connector_output(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) Sets the export output for the Feature Group Deployment to a Database connector. @@ -451,7 +256,6 @@ Module Contents :type additional_id_columns: list - .. py:method:: remove_feature_group_export_output() Removes the export type that is set for the Feature Group Deployment @@ -460,7 +264,6 @@ Module Contents :type deployment_id: str - .. py:method:: set_default_prediction_arguments(prediction_arguments, set_as_override = False) Sets the deployment config. @@ -474,7 +277,6 @@ Module Contents :rtype: Deployment - .. py:method:: create_alert(alert_name, condition_config, action_config) Create a deployment alert for the given conditions. @@ -493,7 +295,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: list_alerts() List the monitor alerts associated with the deployment id. @@ -505,7 +306,6 @@ Module Contents :rtype: list[MonitorAlert] - .. py:method:: create_realtime_monitor(realtime_monitor_schedule = None, lookback_time = None) Real time monitors compute and monitor metrics of real time prediction data. @@ -519,7 +319,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: get_conversation_response(message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, deployment_token = None, doc_infos = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -552,7 +351,6 @@ Module Contents :type doc_infos: list - .. py:method:: get_conversation_response_with_binary_data(deployment_token, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -585,7 +383,6 @@ Module Contents :type attachments: None - .. py:method:: create_batch_prediction(table_name = None, name = None, global_prediction_args = None, batch_prediction_args = None, explanations = False, output_format = None, output_location = None, database_connector_id = None, database_output_config = None, refresh_schedule = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, input_feature_groups = None) Creates a batch prediction job description for the given deployment. @@ -623,7 +420,6 @@ Module Contents :rtype: BatchPrediction - .. py:method:: describe_feature_group_row_process_by_key(primary_key_value) Gets the feature group row process. @@ -635,7 +431,6 @@ Module Contents :rtype: FeatureGroupRowProcess - .. py:method:: list_feature_group_row_processes(limit = None, status = None) Gets a list of feature group row processes. @@ -649,7 +444,6 @@ Module Contents :rtype: list[FeatureGroupRowProcess] - .. py:method:: get_feature_group_row_process_summary() Gets a summary of the statuses of the individual feature group processes. @@ -661,7 +455,6 @@ Module Contents :rtype: FeatureGroupRowProcessSummary - .. py:method:: reset_feature_group_row_process_by_key(primary_key_value) Resets a feature group row process so that it can be reprocessed @@ -673,7 +466,6 @@ Module Contents :rtype: FeatureGroupRowProcess - .. py:method:: get_feature_group_row_process_logs_by_key(primary_key_value) Gets the logs for a feature group row process @@ -685,7 +477,6 @@ Module Contents :rtype: FeatureGroupRowProcessLogs - .. py:method:: create_conversation(name, deployment_token = None, external_application_id = None) Creates a deployment conversation. @@ -701,7 +492,6 @@ Module Contents :rtype: DeploymentConversation - .. py:method:: list_conversations(external_application_id = None) Lists all conversations for the given deployment and current user. @@ -713,7 +503,6 @@ Module Contents :rtype: list[DeploymentConversation] - .. py:method:: create_external_application(name = None, description = None, logo = None, theme = None) Creates a new External Application from an existing ChatLLM Deployment. @@ -731,7 +520,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: download_agent_attachment(attachment_id) Return an agent attachment. @@ -740,7 +528,6 @@ Module Contents :type attachment_id: str - .. py:method:: wait_for_deployment(wait_states={'PENDING', 'DEPLOYING'}, timeout=900) A waiting call until deployment is completed. @@ -749,7 +536,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_pending_deployment_update(timeout=900) A waiting call until deployment is in a stable state, that pending model switch is completed and previous model is stopped. @@ -761,7 +547,6 @@ Module Contents :rtype: Deployment - .. py:method:: get_status() Gets the status of the deployment. @@ -770,7 +555,6 @@ Module Contents :rtype: str - .. py:method:: create_refresh_policy(cron) To create a refresh policy for a deployment. @@ -782,7 +566,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: list_refresh_policies() Gets the refresh policies in a list. diff --git a/docs/_sources/autoapi/abacusai/deployment_auth_token/index.rst.txt b/docs/_sources/autoapi/abacusai/deployment_auth_token/index.rst.txt index 5f5d0d7e9..c79a50d46 100644 --- a/docs/_sources/autoapi/abacusai/deployment_auth_token/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/deployment_auth_token/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.deployment_auth_token -============================== +:py:mod:`abacusai.deployment_auth_token` +======================================== .. py:module:: abacusai.deployment_auth_token -Classes -------- - -.. autoapisummary:: - - abacusai.deployment_auth_token.AbstractApiClass - abacusai.deployment_auth_token.DeploymentAuthToken - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.deployment_auth_token.DeploymentAuthToken - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DeploymentAuthToken(client, deploymentToken=None, createdAt=None, name=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A deployment authentication token that is used to authenticate prediction requests @@ -43,13 +33,11 @@ Module Contents :param name: The name associated with the authentication token. :type name: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/deployment_conversation/index.rst.txt b/docs/_sources/autoapi/abacusai/deployment_conversation/index.rst.txt index 070448273..43e3cc271 100644 --- a/docs/_sources/autoapi/abacusai/deployment_conversation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/deployment_conversation/index.rst.txt @@ -1,116 +1,27 @@ -abacusai.deployment_conversation -================================ +:py:mod:`abacusai.deployment_conversation` +========================================== .. py:module:: abacusai.deployment_conversation -Classes -------- - -.. autoapisummary:: - - abacusai.deployment_conversation.DeploymentConversationEvent - abacusai.deployment_conversation.AbstractApiClass - abacusai.deployment_conversation.DeploymentConversation - - Module Contents --------------- -.. py:class:: DeploymentConversationEvent(client, role=None, text=None, timestamp=None, messageIndex=None, regenerateAttempt=None, modelVersion=None, searchResults=None, isUseful=None, feedback=None, feedbackType=None, docInfos=None, keywordArguments=None, inputParams=None, attachments=None, responseVersion=None, agentWorkflowNodeId=None, nextAgentWorkflowNodeId=None, chatType=None, agentResponse=None, error=None, segments=None, streamedData=None, streamedSectionData=None, highlights=None, llmDisplayName=None, llmBotIcon=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A single deployment conversation message. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param role: The role of the message sender - :type role: str - :param text: The text of the message - :type text: str - :param timestamp: The timestamp at which the message was sent - :type timestamp: str - :param messageIndex: The index of the message in the conversation - :type messageIndex: int - :param regenerateAttempt: The sequence number of regeneration. Not regenerated if 0. - :type regenerateAttempt: int - :param modelVersion: The model instance id associated with the message. - :type modelVersion: str - :param searchResults: The search results for the message. - :type searchResults: dict - :param isUseful: Whether this message was marked as useful or not - :type isUseful: bool - :param feedback: The feedback provided for the message - :type feedback: str - :param feedbackType: The type of feedback provided for the message - :type feedbackType: str - :param docInfos: A list of information on the documents associated with the message - :type docInfos: list - :param keywordArguments: User message only. A dictionary of keyword arguments used to generate response. - :type keywordArguments: dict - :param inputParams: User message only. A dictionary of input parameters used to generate response. - :type inputParams: dict - :param attachments: A list of attachments associated with the message. - :type attachments: list - :param responseVersion: The version of the response, used to differentiate w/ legacy agent response. - :type responseVersion: str - :param agentWorkflowNodeId: The workflow node id associated with the agent response. - :type agentWorkflowNodeId: str - :param nextAgentWorkflowNodeId: The id of the workflow node to be executed next. - :type nextAgentWorkflowNodeId: str - :param chatType: The type of chat llm that was run for the message. - :type chatType: str - :param agentResponse: Response from the agent. Only for conversation with agents. - :type agentResponse: dict - :param error: The error message in case of an error. - :type error: str - :param segments: The segments of the message. - :type segments: list - :param streamedData: Aggregated streamed messages from the agent. - :type streamedData: str - :param streamedSectionData: Aggregated streamed section outputs from the agent in a list. - :type streamedSectionData: str - :param highlights: Chunks with bounding boxes for highlighting the result sources. - :type highlights: dict - :param llmDisplayName: The display name of the LLM model used to generate the response. Only used for system-created bots. - :type llmDisplayName: str - :param llmBotIcon: The icon location of the LLM model used to generate the response. Only used for system-created bots. - :type llmBotIcon: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) +Classes +~~~~~~~ - .. py:method:: __eq__(other) +.. autoapisummary:: - Return self==value. + abacusai.deployment_conversation.DeploymentConversation - .. py:method:: _get_attribute_as_dict(attribute) +.. py:class:: DeploymentConversation(client, deploymentConversationId=None, name=None, deploymentId=None, createdAt=None, lastEventCreatedAt=None, externalSessionId=None, regenerateAttempt=None, externalApplicationId=None, unusedDocumentUploadIds=None, history={}) -.. py:class:: DeploymentConversation(client, deploymentConversationId=None, name=None, deploymentId=None, createdAt=None, lastEventCreatedAt=None, externalSessionId=None, regenerateAttempt=None, externalApplicationId=None, history={}) Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - A deployment conversation. :param client: An authenticated API Client instance @@ -131,16 +42,16 @@ Module Contents :type regenerateAttempt: int :param externalApplicationId: The external application id associated with the deployment conversation. :type externalApplicationId: str + :param unusedDocumentUploadIds: The list of unused document upload ids associated with the deployment conversation. + :type unusedDocumentUploadIds: list[str] :param history: The history of the deployment conversation. :type history: DeploymentConversationEvent - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -149,8 +60,7 @@ Module Contents :rtype: dict - - .. py:method:: get(external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True) + .. py:method:: get(external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True, get_unused_document_uploads = False) Gets a deployment conversation. @@ -162,12 +72,13 @@ Module Contents :type deployment_token: str :param filter_intermediate_conversation_events: If true, intermediate conversation events will be filtered out. Default is true. :type filter_intermediate_conversation_events: bool + :param get_unused_document_uploads: If true, unused document uploads will be returned. Default is false. + :type get_unused_document_uploads: bool :returns: The deployment conversation. :rtype: DeploymentConversation - .. py:method:: delete(deployment_id = None, deployment_token = None) Delete a Deployment Conversation. @@ -178,7 +89,6 @@ Module Contents :type deployment_token: str - .. py:method:: clear(external_session_id = None, deployment_id = None, deployment_token = None, user_message_indices = None) Clear the message history of a Deployment Conversation. @@ -193,7 +103,6 @@ Module Contents :type user_message_indices: list - .. py:method:: set_feedback(message_index, is_useful = None, is_not_useful = None, feedback = None, feedback_type = None, deployment_id = None, deployment_token = None) Sets a deployment conversation message as useful or not useful @@ -214,7 +123,6 @@ Module Contents :type deployment_token: str - .. py:method:: rename(name, deployment_id = None, deployment_token = None) Rename a Deployment Conversation. @@ -227,7 +135,6 @@ Module Contents :type deployment_token: str - .. py:method:: export(external_session_id = None) Export a Deployment Conversation. diff --git a/docs/_sources/autoapi/abacusai/deployment_conversation_event/index.rst.txt b/docs/_sources/autoapi/abacusai/deployment_conversation_event/index.rst.txt index 2b587d03a..e3ae432b7 100644 --- a/docs/_sources/autoapi/abacusai/deployment_conversation_event/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/deployment_conversation_event/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.deployment_conversation_event -====================================== +:py:mod:`abacusai.deployment_conversation_event` +================================================ .. py:module:: abacusai.deployment_conversation_event -Classes -------- - -.. autoapisummary:: - - abacusai.deployment_conversation_event.AbstractApiClass - abacusai.deployment_conversation_event.DeploymentConversationEvent - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.deployment_conversation_event.DeploymentConversationEvent - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DeploymentConversationEvent(client, role=None, text=None, timestamp=None, messageIndex=None, regenerateAttempt=None, modelVersion=None, searchResults=None, isUseful=None, feedback=None, feedbackType=None, docInfos=None, keywordArguments=None, inputParams=None, attachments=None, responseVersion=None, agentWorkflowNodeId=None, nextAgentWorkflowNodeId=None, chatType=None, agentResponse=None, error=None, segments=None, streamedData=None, streamedSectionData=None, highlights=None, llmDisplayName=None, llmBotIcon=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A single deployment conversation message. @@ -89,13 +79,11 @@ Module Contents :param llmBotIcon: The icon location of the LLM model used to generate the response. Only used for system-created bots. :type llmBotIcon: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/deployment_conversation_export/index.rst.txt b/docs/_sources/autoapi/abacusai/deployment_conversation_export/index.rst.txt index 0145adf3d..fd21ebb61 100644 --- a/docs/_sources/autoapi/abacusai/deployment_conversation_export/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/deployment_conversation_export/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.deployment_conversation_export -======================================= +:py:mod:`abacusai.deployment_conversation_export` +================================================= .. py:module:: abacusai.deployment_conversation_export -Classes -------- - -.. autoapisummary:: - - abacusai.deployment_conversation_export.AbstractApiClass - abacusai.deployment_conversation_export.DeploymentConversationExport - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.deployment_conversation_export.DeploymentConversationExport - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DeploymentConversationExport(client, deploymentConversationId=None, conversationExportHtml=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A deployment conversation html export, to be used for downloading the conversation. @@ -41,13 +31,11 @@ Module Contents :param conversationExportHtml: The html string of the deployment conversation. :type conversationExportHtml: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/document_data/index.rst.txt b/docs/_sources/autoapi/abacusai/document_data/index.rst.txt index f429eb8dc..c3736dab6 100644 --- a/docs/_sources/autoapi/abacusai/document_data/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/document_data/index.rst.txt @@ -1,37 +1,27 @@ -abacusai.document_data -====================== +:py:mod:`abacusai.document_data` +================================ .. py:module:: abacusai.document_data -Classes -------- - -.. autoapisummary:: - - abacusai.document_data.AbstractApiClass - abacusai.document_data.DocumentData - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) +Classes +~~~~~~~ - .. py:method:: __eq__(other) +.. autoapisummary:: - Return self==value. + abacusai.document_data.DocumentData - .. py:method:: _get_attribute_as_dict(attribute) +.. py:class:: DocumentData(client, docId=None, mimeType=None, pageCount=None, totalPageCount=None, extractedText=None, embeddedText=None, pages=None, tokens=None, metadata=None, pageMarkdown=None, extractedPageText=None, augmentedPageText=None) -.. py:class:: DocumentData(client, docId=None, mimeType=None, pageCount=None, totalPageCount=None, extractedText=None, embeddedText=None, pages=None, tokens=None, metadata=None, pageMarkdown=None, extractedPageText=None) Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - Data extracted from a docstore document. :param client: An authenticated API Client instance @@ -58,14 +48,14 @@ Module Contents :type pageMarkdown: list :param extractedPageText: List of extracted text for each page in the document obtained from OCR. :type extractedPageText: list - + :param augmentedPageText: List of extracted text for each page in the document obtained from OCR augmented with embedded links in the document. + :type augmentedPageText: list .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/document_retriever/index.rst.txt b/docs/_sources/autoapi/abacusai/document_retriever/index.rst.txt index 2b803b7cb..202b91811 100644 --- a/docs/_sources/autoapi/abacusai/document_retriever/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/document_retriever/index.rst.txt @@ -1,236 +1,26 @@ -abacusai.document_retriever -=========================== +:py:mod:`abacusai.document_retriever` +===================================== .. py:module:: abacusai.document_retriever -Classes -------- - -.. autoapisummary:: - - abacusai.document_retriever.VectorStoreConfig - abacusai.document_retriever.DocumentRetrieverConfig - abacusai.document_retriever.DocumentRetrieverVersion - abacusai.document_retriever.AbstractApiClass - abacusai.document_retriever.DocumentRetriever - - Module Contents --------------- -.. py:class:: VectorStoreConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Config for indexing options of a document retriever. Default values of optional arguments are heuristically selected by the Abacus.AI platform based on the underlying data. - - :param chunk_size: The size of text chunks in the vector store. - :type chunk_size: int - :param chunk_overlap_fraction: The fraction of overlap between chunks. - :type chunk_overlap_fraction: float - :param text_encoder: Encoder used to index texts from the documents. - :type text_encoder: VectorStoreTextEncoder - :param chunk_size_factors: Chunking data with multiple sizes. The specified list of factors are used to calculate more sizes, in addition to `chunk_size`. - :type chunk_size_factors: list - :param score_multiplier_column: If provided, will use the values in this metadata column to modify the relevance score of returned chunks for all queries. - :type score_multiplier_column: str - :param prune_vectors: Transform vectors using SVD so that the average component of vectors in the corpus are removed. - :type prune_vectors: bool - - - .. py:attribute:: chunk_size - :type: int - - - .. py:attribute:: chunk_overlap_fraction - :type: float - - - .. py:attribute:: text_encoder - :type: abacusai.api_class.enums.VectorStoreTextEncoder - - - .. py:attribute:: chunk_size_factors - :type: list - - - .. py:attribute:: score_multiplier_column - :type: str - - - .. py:attribute:: prune_vectors - :type: bool - - -.. py:class:: DocumentRetrieverConfig(client, chunkSize=None, chunkOverlapFraction=None, textEncoder=None, scoreMultiplierColumn=None, pruneVectors=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A config for document retriever creation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param chunkSize: The size of chunks for vector store, i.e., maximum number of words in the chunk. - :type chunkSize: int - :param chunkOverlapFraction: The fraction of overlap between two consecutive chunks. - :type chunkOverlapFraction: float - :param textEncoder: The text encoder used to encode texts in the vector store. - :type textEncoder: str - :param scoreMultiplierColumn: The values in this metadata column are used to modify the relevance scores of returned chunks. - :type scoreMultiplierColumn: str - :param pruneVectors: Corpus specific transformation of vectors that applies dimensional reduction techniques to strip common components from the vectors. - :type pruneVectors: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: DocumentRetrieverVersion(client, documentRetrieverId=None, documentRetrieverVersion=None, createdAt=None, status=None, deploymentStatus=None, featureGroupId=None, featureGroupVersion=None, error=None, numberOfChunks=None, embeddingFileSize=None, warnings=None, resolvedConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of document retriever. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param documentRetrieverId: The unique identifier of the Document Retriever. - :type documentRetrieverId: str - :param documentRetrieverVersion: The unique identifier of the Document Retriever version. - :type documentRetrieverVersion: str - :param createdAt: When the Document Retriever was created. - :type createdAt: str - :param status: The status of creating Document Retriever version. - :type status: str - :param deploymentStatus: The status of deploying the Document Retriever version. - :type deploymentStatus: str - :param featureGroupId: The feature group id associated with the document retriever. - :type featureGroupId: str - :param featureGroupVersion: The unique identifier of the feature group version at which the Document Retriever version is created. - :type featureGroupVersion: str - :param error: The error message when it failed to create the document retriever version. - :type error: str - :param numberOfChunks: The number of chunks for the document retriever. - :type numberOfChunks: int - :param embeddingFileSize: The size of embedding file for the document retriever. - :type embeddingFileSize: int - :param warnings: The warning messages when creating the document retriever. - :type warnings: list - :param resolvedConfig: The resolved configurations, such as default settings, for indexing documents. - :type resolvedConfig: DocumentRetrieverConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DocumentRetrieverVersion - - - - .. py:method:: describe() - - Describe a document retriever version. - - :param document_retriever_version: A unique string identifier associated with the document retriever version. - :type document_retriever_version: str - - :returns: The document retriever version object. - :rtype: DocumentRetrieverVersion - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until document retriever version is complete. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_until_ready(timeout=3600) - - A waiting call until the document retriever version is ready. It restarts the document retriever if it is stopped. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_until_deployment_ready(timeout = 3600) - - A waiting call until the document retriever deployment is ready to serve. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 3600 seconds. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the document retriever version. - - :returns: A string describing the status of a document retriever version (pending, complete, etc.). - :rtype: str - - - - .. py:method:: get_deployment_status() - - Gets the status of the document retriever version. - - :returns: A string describing the deployment status of a document retriever version (pending, deploying, etc.). - :rtype: str - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.document_retriever.DocumentRetriever - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DocumentRetriever(client, name=None, documentRetrieverId=None, createdAt=None, featureGroupId=None, featureGroupName=None, indexingRequired=None, latestDocumentRetrieverVersion={}, documentRetrieverConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A vector store that stores embeddings for a list of document trunks. @@ -253,13 +43,11 @@ Module Contents :param documentRetrieverConfig: The config for vector store creation. :type documentRetrieverConfig: DocumentRetrieverConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -268,7 +56,6 @@ Module Contents :rtype: dict - .. py:method:: rename(name) Updates an existing document retriever. @@ -280,7 +67,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: create_version(feature_group_id = None, document_retriever_config = None) Creates a document retriever version from the latest version of the feature group that the document retriever associated with. @@ -294,7 +80,6 @@ Module Contents :rtype: DocumentRetrieverVersion - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -303,7 +88,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: describe() Describe a Document Retriever. @@ -315,7 +99,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: list_versions(limit = 100, start_after_version = None) List all the document retriever versions with a given ID. @@ -329,7 +112,6 @@ Module Contents :rtype: list[DocumentRetrieverVersion] - .. py:method:: get_document_snippet(document_id, start_word_index = None, end_word_index = None) Get a snippet from documents in the document retriever. @@ -345,7 +127,6 @@ Module Contents :rtype: DocumentRetrieverLookupResult - .. py:method:: restart() Restart the document retriever if it is stopped. This will start the deployment of the document retriever, @@ -357,7 +138,6 @@ Module Contents :type document_retriever_id: str - .. py:method:: wait_until_ready(timeout = 3600) A waiting call until document retriever is ready. It restarts the document retriever if it is stopped. @@ -366,7 +146,6 @@ Module Contents :type timeout: int - .. py:method:: wait_until_deployment_ready(timeout = 3600) A waiting call until the document retriever deployment is ready to serve. @@ -375,7 +154,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the indexing status of the document retriever. @@ -384,7 +162,6 @@ Module Contents :rtype: str - .. py:method:: get_deployment_status() Gets the deployment status of the document retriever. @@ -393,7 +170,6 @@ Module Contents :rtype: str - .. py:method:: get_matching_documents(query, filters = None, limit = None, result_columns = None, max_words = None, num_retrieval_margin_words = None, max_words_per_chunk = None, score_multiplier_column = None, min_score = None, required_phrases = None, filter_clause = None, crowding_limits = None) Lookup document retrievers and return the matching documents from the document retriever deployed with given query. diff --git a/docs/_sources/autoapi/abacusai/document_retriever_config/index.rst.txt b/docs/_sources/autoapi/abacusai/document_retriever_config/index.rst.txt index 7e036e43d..fe35d29c2 100644 --- a/docs/_sources/autoapi/abacusai/document_retriever_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/document_retriever_config/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.document_retriever_config -================================== +:py:mod:`abacusai.document_retriever_config` +============================================ .. py:module:: abacusai.document_retriever_config -Classes -------- - -.. autoapisummary:: - - abacusai.document_retriever_config.AbstractApiClass - abacusai.document_retriever_config.DocumentRetrieverConfig - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.document_retriever_config.DocumentRetrieverConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DocumentRetrieverConfig(client, chunkSize=None, chunkOverlapFraction=None, textEncoder=None, scoreMultiplierColumn=None, pruneVectors=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A config for document retriever creation. @@ -47,13 +37,11 @@ Module Contents :param pruneVectors: Corpus specific transformation of vectors that applies dimensional reduction techniques to strip common components from the vectors. :type pruneVectors: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/document_retriever_lookup_result/index.rst.txt b/docs/_sources/autoapi/abacusai/document_retriever_lookup_result/index.rst.txt index 6b04f1299..ead649dc8 100644 --- a/docs/_sources/autoapi/abacusai/document_retriever_lookup_result/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/document_retriever_lookup_result/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.document_retriever_lookup_result -========================================= +:py:mod:`abacusai.document_retriever_lookup_result` +=================================================== .. py:module:: abacusai.document_retriever_lookup_result -Classes -------- - -.. autoapisummary:: - - abacusai.document_retriever_lookup_result.AbstractApiClass - abacusai.document_retriever_lookup_result.DocumentRetrieverLookupResult - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.document_retriever_lookup_result.DocumentRetrieverLookupResult - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DocumentRetrieverLookupResult(client, document=None, score=None, properties=None, pages=None, boundingBoxes=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Result of a document retriever lookup. @@ -47,13 +37,11 @@ Module Contents :param boundingBoxes: Bounding boxes of the retrieved text from the original document. :type boundingBoxes: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/document_retriever_version/index.rst.txt b/docs/_sources/autoapi/abacusai/document_retriever_version/index.rst.txt index 99cead63e..34e896891 100644 --- a/docs/_sources/autoapi/abacusai/document_retriever_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/document_retriever_version/index.rst.txt @@ -1,73 +1,26 @@ -abacusai.document_retriever_version -=================================== +:py:mod:`abacusai.document_retriever_version` +============================================= .. py:module:: abacusai.document_retriever_version -Classes -------- - -.. autoapisummary:: - - abacusai.document_retriever_version.DocumentRetrieverConfig - abacusai.document_retriever_version.AbstractApiClass - abacusai.document_retriever_version.DocumentRetrieverVersion - - Module Contents --------------- -.. py:class:: DocumentRetrieverConfig(client, chunkSize=None, chunkOverlapFraction=None, textEncoder=None, scoreMultiplierColumn=None, pruneVectors=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A config for document retriever creation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param chunkSize: The size of chunks for vector store, i.e., maximum number of words in the chunk. - :type chunkSize: int - :param chunkOverlapFraction: The fraction of overlap between two consecutive chunks. - :type chunkOverlapFraction: float - :param textEncoder: The text encoder used to encode texts in the vector store. - :type textEncoder: str - :param scoreMultiplierColumn: The values in this metadata column are used to modify the relevance scores of returned chunks. - :type scoreMultiplierColumn: str - :param pruneVectors: Corpus specific transformation of vectors that applies dimensional reduction techniques to strip common components from the vectors. - :type pruneVectors: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.document_retriever_version.DocumentRetrieverVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DocumentRetrieverVersion(client, documentRetrieverId=None, documentRetrieverVersion=None, createdAt=None, status=None, deploymentStatus=None, featureGroupId=None, featureGroupVersion=None, error=None, numberOfChunks=None, embeddingFileSize=None, warnings=None, resolvedConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of document retriever. @@ -98,13 +51,11 @@ Module Contents :param resolvedConfig: The resolved configurations, such as default settings, for indexing documents. :type resolvedConfig: DocumentRetrieverConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -113,7 +64,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -122,7 +72,6 @@ Module Contents :rtype: DocumentRetrieverVersion - .. py:method:: describe() Describe a document retriever version. @@ -134,7 +83,6 @@ Module Contents :rtype: DocumentRetrieverVersion - .. py:method:: wait_for_results(timeout=3600) A waiting call until document retriever version is complete. @@ -143,7 +91,6 @@ Module Contents :type timeout: int - .. py:method:: wait_until_ready(timeout=3600) A waiting call until the document retriever version is ready. It restarts the document retriever if it is stopped. @@ -152,7 +99,6 @@ Module Contents :type timeout: int - .. py:method:: wait_until_deployment_ready(timeout = 3600) A waiting call until the document retriever deployment is ready to serve. @@ -161,7 +107,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the document retriever version. @@ -170,7 +115,6 @@ Module Contents :rtype: str - .. py:method:: get_deployment_status() Gets the status of the document retriever version. diff --git a/docs/_sources/autoapi/abacusai/drift_distribution/index.rst.txt b/docs/_sources/autoapi/abacusai/drift_distribution/index.rst.txt index 68e46135d..c970b569e 100644 --- a/docs/_sources/autoapi/abacusai/drift_distribution/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/drift_distribution/index.rst.txt @@ -1,77 +1,26 @@ -abacusai.drift_distribution -=========================== +:py:mod:`abacusai.drift_distribution` +===================================== .. py:module:: abacusai.drift_distribution -Classes -------- - -.. autoapisummary:: - - abacusai.drift_distribution.FeatureDistribution - abacusai.drift_distribution.AbstractApiClass - abacusai.drift_distribution.DriftDistribution - - Module Contents --------------- -.. py:class:: FeatureDistribution(client, type=None, trainingDistribution=None, predictionDistribution=None, numericalTrainingDistribution=None, numericalPredictionDistribution=None, trainingStatistics=None, predictionStatistics=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - For a single feature, how it has changed in the training data versus some specified window - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: Data type of values in each distribution, typically 'categorical' or 'numerical'. - :type type: str - :param trainingDistribution: A dict describing the range of values in the training distribution. - :type trainingDistribution: dict - :param predictionDistribution: A dict describing the range of values in the specified window. - :type predictionDistribution: dict - :param numericalTrainingDistribution: A dict describing the summary statistics of the numerical training distribution. - :type numericalTrainingDistribution: dict - :param numericalPredictionDistribution: A dict describing the summary statistics of the numerical prediction distribution. - :type numericalPredictionDistribution: dict - :param trainingStatistics: A dict describing summary statistics of values in the training distribution. - :type trainingStatistics: dict - :param predictionStatistics: A dict describing summary statistics of values in the specified window. - :type predictionStatistics: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.drift_distribution.DriftDistribution - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DriftDistribution(client, trainColumn=None, predictedColumn=None, metrics=None, distribution={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` How actuals or predicted values have changed in the training data versus predicted data @@ -86,13 +35,11 @@ Module Contents :param distribution: A FeatureDistribution, how the training data compares to the predicted data. :type distribution: FeatureDistribution - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/drift_distributions/index.rst.txt b/docs/_sources/autoapi/abacusai/drift_distributions/index.rst.txt index f3c0e0beb..b9ad7dcbf 100644 --- a/docs/_sources/autoapi/abacusai/drift_distributions/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/drift_distributions/index.rst.txt @@ -1,71 +1,26 @@ -abacusai.drift_distributions -============================ +:py:mod:`abacusai.drift_distributions` +====================================== .. py:module:: abacusai.drift_distributions -Classes -------- - -.. autoapisummary:: - - abacusai.drift_distributions.DriftDistribution - abacusai.drift_distributions.AbstractApiClass - abacusai.drift_distributions.DriftDistributions - - Module Contents --------------- -.. py:class:: DriftDistribution(client, trainColumn=None, predictedColumn=None, metrics=None, distribution={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - How actuals or predicted values have changed in the training data versus predicted data - - :param client: An authenticated API Client instance - :type client: ApiClient - :param trainColumn: The feature name in the train table. - :type trainColumn: str - :param predictedColumn: The feature name in the prediction table. - :type predictedColumn: str - :param metrics: Drift measures. - :type metrics: dict - :param distribution: A FeatureDistribution, how the training data compares to the predicted data. - :type distribution: FeatureDistribution - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.drift_distributions.DriftDistributions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: DriftDistributions(client, labelDrift={}, predictionDrift={}, bpPredictionDrift={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` For either actuals or predicted values, how it has changed in the training data versus some specified window @@ -78,13 +33,11 @@ Module Contents :param bpPredictionDrift: A DriftDistribution describing column names and the range of values for prediction drift, when the predictions come from BP. :type bpPredictionDrift: DriftDistribution - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda/index.rst.txt b/docs/_sources/autoapi/abacusai/eda/index.rst.txt index 95d3db5ff..b6114d90e 100644 --- a/docs/_sources/autoapi/abacusai/eda/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda/index.rst.txt @@ -1,226 +1,26 @@ -abacusai.eda -============ +:py:mod:`abacusai.eda` +====================== .. py:module:: abacusai.eda -Classes -------- - -.. autoapisummary:: - - abacusai.eda.EdaVersion - abacusai.eda.RefreshSchedule - abacusai.eda.AbstractApiClass - abacusai.eda.Eda - - Module Contents --------------- -.. py:class:: EdaVersion(client, edaVersion=None, status=None, edaId=None, edaStartedAt=None, edaCompletedAt=None, referenceFeatureGroupVersion=None, testFeatureGroupVersion=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of an eda object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param edaVersion: The unique identifier of a eda version. - :type edaVersion: str - :param status: The current status of the eda object. - :type status: str - :param edaId: A reference to the eda this version belongs to. - :type edaId: str - :param edaStartedAt: The start time and date of the eda process. - :type edaStartedAt: str - :param edaCompletedAt: The end time and date of the eda process. - :type edaCompletedAt: str - :param referenceFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is analyzing. - :type referenceFeatureGroupVersion: list[str] - :param testFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is analyzing. - :type testFeatureGroupVersion: list[str] - :param error: Relevant error if the status is FAILED. - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: EdaVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified EDA version. - - :param eda_version: Unique string identifier of the EDA version. - :type eda_version: str - - :returns: An EDA version. - :rtype: EdaVersion - - - - .. py:method:: delete() - - Deletes the specified EDA version. - - :param eda_version: Unique string identifier of the EDA version to delete. - :type eda_version: str - - - - .. py:method:: get_eda_collinearity() - - Gets the Collinearity between all features for the Exploratory Data Analysis. - - :param eda_version: Unique string identifier associated with the EDA instance. - :type eda_version: str - - :returns: An object with a record of correlations between each feature for the EDA. - :rtype: EdaCollinearity - - - - .. py:method:: get_eda_data_consistency(transformation_feature = None) - - Gets the data consistency for the Exploratory Data Analysis. - - :param transformation_feature: The transformation feature to get consistency for. - :type transformation_feature: str - - :returns: Object with duplication, deletion, and transformation data for data consistency analysis for an EDA. - :rtype: EdaDataConsistency - - - - .. py:method:: get_collinearity_for_feature(feature_name = None) - - Gets the Collinearity for the given feature from the Exploratory Data Analysis. - - :param feature_name: Name of the feature for which correlation is shown. - :type feature_name: str - - :returns: Object with a record of correlations for the provided feature for an EDA. - :rtype: EdaFeatureCollinearity - - - - .. py:method:: get_feature_association(reference_feature_name, test_feature_name) - - Gets the Feature Association for the given features from the feature group version within the eda_version. - - :param reference_feature_name: Name of the feature for feature association (on x-axis for the plots generated for the Feature association in the product). - :type reference_feature_name: str - :param test_feature_name: Name of the feature for feature association (on y-axis for the plots generated for the Feature association in the product). - :type test_feature_name: str - - :returns: An object with a record of data for the feature association between the two given features for an EDA version. - :rtype: EdaFeatureAssociation - - - - .. py:method:: get_eda_forecasting_analysis() - - Gets the Forecasting analysis for the Exploratory Data Analysis. - - :param eda_version: Unique string identifier associated with the EDA version. - :type eda_version: str - - :returns: Object with forecasting analysis that includes sales_across_time, cummulative_contribution, missing_value_distribution, history_length, num_rows_histogram, product_maturity data. - :rtype: EdaForecastingAnalysis - - - - .. py:method:: wait_for_eda(timeout=1200) - - A waiting call until eda version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the eda version. - - :returns: A string describing the status of the model monitor version, for e.g., pending, complete, etc. - :rtype: str - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda.Eda - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Eda(client, edaId=None, name=None, createdAt=None, projectId=None, featureGroupId=None, referenceFeatureGroupVersion=None, testFeatureGroupVersion=None, edaConfigs=None, latestEdaVersion={}, refreshSchedules={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A exploratory data analysis object @@ -247,13 +47,11 @@ Module Contents :param refreshSchedules: List of refresh schedules that indicate when the next model version will be trained. :type refreshSchedules: RefreshSchedule - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -262,7 +60,6 @@ Module Contents :rtype: dict - .. py:method:: rerun() Reruns the specified EDA object. @@ -274,7 +71,6 @@ Module Contents :rtype: Eda - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -283,7 +79,6 @@ Module Contents :rtype: Eda - .. py:method:: describe() Retrieves a full description of the specified EDA object. @@ -295,7 +90,6 @@ Module Contents :rtype: Eda - .. py:method:: list_versions(limit = 100, start_after_version = None) Retrieves a list of versions for a given EDA object. @@ -309,7 +103,6 @@ Module Contents :rtype: list[EdaVersion] - .. py:method:: rename(name) Renames an EDA @@ -318,7 +111,6 @@ Module Contents :type name: str - .. py:method:: delete() Deletes the specified EDA and all its versions. diff --git a/docs/_sources/autoapi/abacusai/eda_chart_description/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_chart_description/index.rst.txt index f6868d831..2b4386a7b 100644 --- a/docs/_sources/autoapi/abacusai/eda_chart_description/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_chart_description/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.eda_chart_description -============================== +:py:mod:`abacusai.eda_chart_description` +======================================== .. py:module:: abacusai.eda_chart_description -Classes -------- - -.. autoapisummary:: - - abacusai.eda_chart_description.AbstractApiClass - abacusai.eda_chart_description.EdaChartDescription - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_chart_description.EdaChartDescription - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaChartDescription(client, chartType=None, description=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Eda Chart Description. @@ -41,13 +31,11 @@ Module Contents :param description: Description of the eda chart. :type description: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda_collinearity/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_collinearity/index.rst.txt index be54f41e4..531ef85b0 100644 --- a/docs/_sources/autoapi/abacusai/eda_collinearity/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_collinearity/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.eda_collinearity -========================= +:py:mod:`abacusai.eda_collinearity` +=================================== .. py:module:: abacusai.eda_collinearity -Classes -------- - -.. autoapisummary:: - - abacusai.eda_collinearity.AbstractApiClass - abacusai.eda_collinearity.EdaCollinearity - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_collinearity.EdaCollinearity - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaCollinearity(client, columnNames=None, collinearityMatrix=None, groupFeatureDict=None, collinearityGroups=None, columnNamesX=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Eda Collinearity of the latest version of the data between all the features. @@ -47,13 +37,11 @@ Module Contents :param columnNamesX: Name of all the features in the x axis of the collinearity matrix :type columnNamesX: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda_data_consistency/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_data_consistency/index.rst.txt index ed280b116..f72070f7b 100644 --- a/docs/_sources/autoapi/abacusai/eda_data_consistency/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_data_consistency/index.rst.txt @@ -1,69 +1,26 @@ -abacusai.eda_data_consistency -============================= +:py:mod:`abacusai.eda_data_consistency` +======================================= .. py:module:: abacusai.eda_data_consistency -Classes -------- - -.. autoapisummary:: - - abacusai.eda_data_consistency.DataConsistencyDuplication - abacusai.eda_data_consistency.AbstractApiClass - abacusai.eda_data_consistency.EdaDataConsistency - - Module Contents --------------- -.. py:class:: DataConsistencyDuplication(client, totalCount=None, numDuplicates=None, sample={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Data Consistency for duplication within data - - :param client: An authenticated API Client instance - :type client: ApiClient - :param totalCount: Total count of rows in data. - :type totalCount: int - :param numDuplicates: Number of Duplicates based on primary keys in data. - :type numDuplicates: int - :param sample: A list of dicts enumerating rows the rows that contained duplications in primary keys. - :type sample: FeatureRecord - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_data_consistency.EdaDataConsistency - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaDataConsistency(client, columnNames=None, primaryKeys=None, transformationColumnNames=None, baseDuplicates={}, compareDuplicates={}, deletions={}, transformations={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Eda Data Consistency, contained the duplicates in the base version, Comparison version, Deletions between the base and comparison and feature transformations between the base and comparison data. @@ -84,13 +41,11 @@ Module Contents :param transformations: A DataConsistencyTransformation the number of changes that occured per feature in the data :type transformations: DataConsistencyTransformation - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda_feature_association/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_feature_association/index.rst.txt index 76df3fa22..0e9e8ef6a 100644 --- a/docs/_sources/autoapi/abacusai/eda_feature_association/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_feature_association/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.eda_feature_association -================================ +:py:mod:`abacusai.eda_feature_association` +========================================== .. py:module:: abacusai.eda_feature_association -Classes -------- - -.. autoapisummary:: - - abacusai.eda_feature_association.AbstractApiClass - abacusai.eda_feature_association.EdaFeatureAssociation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_feature_association.EdaFeatureAssociation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaFeatureAssociation(client, data=None, isScatter=None, isBoxWhisker=None, xAxis=None, yAxis=None, xAxisColumnValues=None, yAxisColumnValues=None, dataColumns=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Eda Feature Association between two features in the data. @@ -53,13 +43,11 @@ Module Contents :param dataColumns: A list of columns listed in the data as keys :type dataColumns: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda_feature_collinearity/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_feature_collinearity/index.rst.txt index dbcabf5de..dd126e9e8 100644 --- a/docs/_sources/autoapi/abacusai/eda_feature_collinearity/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_feature_collinearity/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.eda_feature_collinearity -================================= +:py:mod:`abacusai.eda_feature_collinearity` +=========================================== .. py:module:: abacusai.eda_feature_collinearity -Classes -------- - -.. autoapisummary:: - - abacusai.eda_feature_collinearity.AbstractApiClass - abacusai.eda_feature_collinearity.EdaFeatureCollinearity - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_feature_collinearity.EdaFeatureCollinearity - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaFeatureCollinearity(client, selectedFeature=None, sortedColumnNames=None, featureCollinearity=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Eda Collinearity of the latest version of the data for a given feature. @@ -43,13 +33,11 @@ Module Contents :param featureCollinearity: A dict describing the collinearity between a given feature and all the features in the data :type featureCollinearity: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda_forecasting_analysis/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_forecasting_analysis/index.rst.txt index 5e8d23e7d..3e778f964 100644 --- a/docs/_sources/autoapi/abacusai/eda_forecasting_analysis/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_forecasting_analysis/index.rst.txt @@ -1,79 +1,26 @@ -abacusai.eda_forecasting_analysis -================================= +:py:mod:`abacusai.eda_forecasting_analysis` +=========================================== .. py:module:: abacusai.eda_forecasting_analysis -Classes -------- - -.. autoapisummary:: - - abacusai.eda_forecasting_analysis.ForecastingAnalysisGraphData - abacusai.eda_forecasting_analysis.AbstractApiClass - abacusai.eda_forecasting_analysis.EdaForecastingAnalysis - - Module Contents --------------- -.. py:class:: ForecastingAnalysisGraphData(client, data=None, xAxis=None, yAxis=None, dataColumns=None, chartName=None, chartTypes=None, itemStatistics={}, chartDescriptions={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Forecasting Analysis Graph Data representation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param data: List of graph data - :type data: list - :param xAxis: Feature that represents the x axis - :type xAxis: str - :param yAxis: Feature that represents the y axis - :type yAxis: str - :param dataColumns: Ordered name of the column for each rowwise data - :type dataColumns: list - :param chartName: Name of the chart represented by the data - :type chartName: str - :param chartTypes: Type of charts in that can exist in the current data. - :type chartTypes: list - :param itemStatistics: In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max - :type itemStatistics: ItemStatistics - :param chartDescriptions: List of descriptions of what the chart contains - :type chartDescriptions: EdaChartDescription - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_forecasting_analysis.EdaForecastingAnalysis - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaForecastingAnalysis(client, primaryKeys=None, forecastingTargetFeature=None, timestampFeature=None, forecastFrequency=None, salesAcrossTime={}, cummulativeContribution={}, missingValueDistribution={}, historyLength={}, numRowsHistogram={}, productMaturity={}, seasonalityYear={}, seasonalityMonth={}, seasonalityWeekOfYear={}, seasonalityDayOfYear={}, seasonalityDayOfMonth={}, seasonalityDayOfWeek={}, seasonalityQuarter={}, seasonalityHour={}, seasonalityMinute={}, seasonalitySecond={}, autocorrelation={}, partialAutocorrelation={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Eda Forecasting Analysis of the latest version of the data. @@ -124,13 +71,11 @@ Module Contents :param partialAutocorrelation: Data showing the correlation of the forecasting target and its lagged values, controlling for the effects of intervening lags. :type partialAutocorrelation: ForecastingAnalysisGraphData - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/eda_version/index.rst.txt b/docs/_sources/autoapi/abacusai/eda_version/index.rst.txt index 4f7a2fa1d..ee558465e 100644 --- a/docs/_sources/autoapi/abacusai/eda_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/eda_version/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.eda_version -==================== +:py:mod:`abacusai.eda_version` +============================== .. py:module:: abacusai.eda_version -Classes -------- - -.. autoapisummary:: - - abacusai.eda_version.AbstractApiClass - abacusai.eda_version.EdaVersion - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.eda_version.EdaVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EdaVersion(client, edaVersion=None, status=None, edaId=None, edaStartedAt=None, edaCompletedAt=None, referenceFeatureGroupVersion=None, testFeatureGroupVersion=None, error=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of an eda object @@ -53,13 +43,11 @@ Module Contents :param error: Relevant error if the status is FAILED. :type error: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -68,7 +56,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -77,7 +64,6 @@ Module Contents :rtype: EdaVersion - .. py:method:: describe() Retrieves a full description of the specified EDA version. @@ -89,7 +75,6 @@ Module Contents :rtype: EdaVersion - .. py:method:: delete() Deletes the specified EDA version. @@ -98,7 +83,6 @@ Module Contents :type eda_version: str - .. py:method:: get_eda_collinearity() Gets the Collinearity between all features for the Exploratory Data Analysis. @@ -110,7 +94,6 @@ Module Contents :rtype: EdaCollinearity - .. py:method:: get_eda_data_consistency(transformation_feature = None) Gets the data consistency for the Exploratory Data Analysis. @@ -122,7 +105,6 @@ Module Contents :rtype: EdaDataConsistency - .. py:method:: get_collinearity_for_feature(feature_name = None) Gets the Collinearity for the given feature from the Exploratory Data Analysis. @@ -134,7 +116,6 @@ Module Contents :rtype: EdaFeatureCollinearity - .. py:method:: get_feature_association(reference_feature_name, test_feature_name) Gets the Feature Association for the given features from the feature group version within the eda_version. @@ -148,7 +129,6 @@ Module Contents :rtype: EdaFeatureAssociation - .. py:method:: get_eda_forecasting_analysis() Gets the Forecasting analysis for the Exploratory Data Analysis. @@ -160,7 +140,6 @@ Module Contents :rtype: EdaForecastingAnalysis - .. py:method:: wait_for_eda(timeout=1200) A waiting call until eda version is ready. @@ -169,7 +148,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the eda version. diff --git a/docs/_sources/autoapi/abacusai/embedding_feature_drift_distribution/index.rst.txt b/docs/_sources/autoapi/abacusai/embedding_feature_drift_distribution/index.rst.txt index 15ed0af4d..1ab338c1a 100644 --- a/docs/_sources/autoapi/abacusai/embedding_feature_drift_distribution/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/embedding_feature_drift_distribution/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.embedding_feature_drift_distribution -============================================= +:py:mod:`abacusai.embedding_feature_drift_distribution` +======================================================= .. py:module:: abacusai.embedding_feature_drift_distribution -Classes -------- - -.. autoapisummary:: - - abacusai.embedding_feature_drift_distribution.AbstractApiClass - abacusai.embedding_feature_drift_distribution.EmbeddingFeatureDriftDistribution - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.embedding_feature_drift_distribution.EmbeddingFeatureDriftDistribution - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: EmbeddingFeatureDriftDistribution(client, distance=None, jsDistance=None, wsDistance=None, ksStatistic=None, psi=None, csi=None, chiSquare=None, averageDrift={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Feature distribution for embeddings @@ -53,13 +43,11 @@ Module Contents :param averageDrift: Average drift embedding for each type of drift :type averageDrift: DriftTypesValue - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/execute_feature_group_operation/index.rst.txt b/docs/_sources/autoapi/abacusai/execute_feature_group_operation/index.rst.txt index d485095b2..f1a4afc53 100644 --- a/docs/_sources/autoapi/abacusai/execute_feature_group_operation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/execute_feature_group_operation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.execute_feature_group_operation -======================================== +:py:mod:`abacusai.execute_feature_group_operation` +================================================== .. py:module:: abacusai.execute_feature_group_operation -Classes -------- - -.. autoapisummary:: - - abacusai.execute_feature_group_operation.AbstractApiClass - abacusai.execute_feature_group_operation.ExecuteFeatureGroupOperation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.execute_feature_group_operation.ExecuteFeatureGroupOperation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ExecuteFeatureGroupOperation(client, featureGroupOperationRunId=None, status=None, error=None, query=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The result of executing a SQL query @@ -45,13 +35,11 @@ Module Contents :param query: The SQL query of the operation :type query: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -60,7 +48,6 @@ Module Contents :rtype: dict - .. py:method:: wait_for_results(timeout=3600, delay=2) A waiting call until query is executed. @@ -71,7 +58,6 @@ Module Contents :type delay: int - .. py:method:: wait_for_execution(timeout=3600, delay=2) A waiting call until query is executed. @@ -82,7 +68,6 @@ Module Contents :type delay: int - .. py:method:: get_status() Gets the status of the query execution @@ -91,7 +76,6 @@ Module Contents :rtype: str - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -100,7 +84,6 @@ Module Contents :rtype: DatasetVersion - .. py:method:: describe() Gets the description of the query execution @@ -109,7 +92,6 @@ Module Contents :rtype: ExecuteFeatureGroupOperation - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) diff --git a/docs/_sources/autoapi/abacusai/external_application/index.rst.txt b/docs/_sources/autoapi/abacusai/external_application/index.rst.txt index 1ec8c5191..5615a7fb1 100644 --- a/docs/_sources/autoapi/abacusai/external_application/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/external_application/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.external_application -============================= +:py:mod:`abacusai.external_application` +======================================= .. py:module:: abacusai.external_application -Classes -------- - -.. autoapisummary:: - - abacusai.external_application.AbstractApiClass - abacusai.external_application.ExternalApplication - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.external_application.ExternalApplication - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ExternalApplication(client, name=None, externalApplicationId=None, deploymentId=None, description=None, logo=None, theme=None, userGroupIds=None, useCase=None, status=None, deploymentConversationRetentionHours=None, managedUserService=None, predictionOverrides=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An external application. @@ -61,13 +51,11 @@ Module Contents :param predictionOverrides: The prediction overrides for the external application. :type predictionOverrides: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -76,7 +64,6 @@ Module Contents :rtype: dict - .. py:method:: update(name = None, description = None, theme = None, deployment_id = None, deployment_conversation_retention_hours = None, reset_retention_policy = False) Updates an External Application. @@ -98,7 +85,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -107,7 +93,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: describe() Describes an External Application. @@ -119,7 +104,6 @@ Module Contents :rtype: ExternalApplication - .. py:method:: delete() Deletes an External Application. diff --git a/docs/_sources/autoapi/abacusai/external_invite/index.rst.txt b/docs/_sources/autoapi/abacusai/external_invite/index.rst.txt index 330006f4c..42d16d1b2 100644 --- a/docs/_sources/autoapi/abacusai/external_invite/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/external_invite/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.external_invite -======================== +:py:mod:`abacusai.external_invite` +================================== .. py:module:: abacusai.external_invite -Classes -------- - -.. autoapisummary:: - - abacusai.external_invite.AbstractApiClass - abacusai.external_invite.ExternalInvite - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.external_invite.ExternalInvite - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ExternalInvite(client, userAlreadyInOrg=None, userAlreadyInAppGroup=None, userExistsAsInternal=None, successfulInvites=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The response of the invites for different emails @@ -45,13 +35,11 @@ Module Contents :param successfulInvites: List of users successfully invited. :type successfulInvites: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/extracted_fields/index.rst.txt b/docs/_sources/autoapi/abacusai/extracted_fields/index.rst.txt index dc74a45f9..4c009d3c3 100644 --- a/docs/_sources/autoapi/abacusai/extracted_fields/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/extracted_fields/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.extracted_fields -========================= +:py:mod:`abacusai.extracted_fields` +=================================== .. py:module:: abacusai.extracted_fields -Classes -------- - -.. autoapisummary:: - - abacusai.extracted_fields.AbstractApiClass - abacusai.extracted_fields.ExtractedFields - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.extracted_fields.ExtractedFields - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ExtractedFields(client, data=None, rawLlmResponse=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The fields extracted from a document. @@ -41,13 +31,11 @@ Module Contents :param rawLlmResponse: The raw llm response. Only returned if it could not be parsed to json. :type rawLlmResponse: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature/index.rst.txt b/docs/_sources/autoapi/abacusai/feature/index.rst.txt index be896047a..a3cc7a34e 100644 --- a/docs/_sources/autoapi/abacusai/feature/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature/index.rst.txt @@ -1,124 +1,26 @@ -abacusai.feature -================ +:py:mod:`abacusai.feature` +========================== .. py:module:: abacusai.feature -Classes -------- - -.. autoapisummary:: - - abacusai.feature.NestedFeature - abacusai.feature.PointInTimeFeature - abacusai.feature.AbstractApiClass - abacusai.feature.Feature - - Module Contents --------------- -.. py:class:: NestedFeature(client, name=None, selectClause=None, featureType=None, featureMapping=None, dataType=None, sourceTable=None, originalName=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A nested feature in a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column - :type name: str - :param selectClause: The sql logic for creating this feature's data - :type selectClause: str - :param featureType: Feature Type of the Feature - :type featureType: str - :param featureMapping: The Feature Mapping of the feature - :type featureMapping: str - :param dataType: Data Type of the Feature - :type dataType: str - :param sourceTable: The source table of the column - :type sourceTable: str - :param originalName: The original name of the column - :type originalName: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PointInTimeFeature(client, historyTableName=None, aggregationKeys=None, timestampKey=None, historicalTimestampKey=None, lookbackWindowSeconds=None, lookbackWindowLagSeconds=None, lookbackCount=None, lookbackUntilPosition=None, expression=None, groupName=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point-in-time feature description - - :param client: An authenticated API Client instance - :type client: ApiClient - :param historyTableName: The name of the history table. If not specified, the current table is used for a self-join. - :type historyTableName: str - :param aggregationKeys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregationKeys: list[str] - :param timestampKey: Name of feature which contains the timestamp value for the point-in-time feature. - :type timestampKey: str - :param historicalTimestampKey: Name of feature which contains the historical timestamp. - :type historicalTimestampKey: str - :param lookbackWindowSeconds: If window is specified in terms of time, the number of seconds in the past from the current time for the start of the window. - :type lookbackWindowSeconds: float - :param lookbackWindowLagSeconds: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, we are looking at the "future" rows in the history table. - :type lookbackWindowLagSeconds: float - :param lookbackCount: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookbackCount: int - :param lookbackUntilPosition: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookbackUntilPosition: int - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param groupName: The group name this point-in-time feature belongs to. - :type groupName: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature.Feature - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Feature(client, name=None, selectClause=None, featureMapping=None, sourceTable=None, originalName=None, usingClause=None, orderClause=None, whereClause=None, featureType=None, dataType=None, detectedFeatureType=None, detectedDataType=None, columns={}, pointInTimeInfo={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A feature in a feature group @@ -153,13 +55,11 @@ Module Contents :param pointInTimeInfo: Point in time column information :type pointInTimeInfo: PointInTimeFeature - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_distribution/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_distribution/index.rst.txt index 69aa6f2f3..9db169164 100644 --- a/docs/_sources/autoapi/abacusai/feature_distribution/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_distribution/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_distribution -============================= +:py:mod:`abacusai.feature_distribution` +======================================= .. py:module:: abacusai.feature_distribution -Classes -------- - -.. autoapisummary:: - - abacusai.feature_distribution.AbstractApiClass - abacusai.feature_distribution.FeatureDistribution - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_distribution.FeatureDistribution - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureDistribution(client, type=None, trainingDistribution=None, predictionDistribution=None, numericalTrainingDistribution=None, numericalPredictionDistribution=None, trainingStatistics=None, predictionStatistics=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` For a single feature, how it has changed in the training data versus some specified window @@ -51,13 +41,11 @@ Module Contents :param predictionStatistics: A dict describing summary statistics of values in the specified window. :type predictionStatistics: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_drift_record/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_drift_record/index.rst.txt index 0873b1855..3f2344cc1 100644 --- a/docs/_sources/autoapi/abacusai/feature_drift_record/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_drift_record/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_drift_record -============================= +:py:mod:`abacusai.feature_drift_record` +======================================= .. py:module:: abacusai.feature_drift_record -Classes -------- - -.. autoapisummary:: - - abacusai.feature_drift_record.AbstractApiClass - abacusai.feature_drift_record.FeatureDriftRecord - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_drift_record.FeatureDriftRecord - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureDriftRecord(client, name=None, distance=None, jsDistance=None, wsDistance=None, ksStatistic=None, psi=None, csi=None, chiSquare=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Value of each type of drift @@ -53,13 +43,11 @@ Module Contents :param chiSquare: Chi-square statistic computed between the training distribution and the range of values in the specified window. :type chiSquare: float - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_drift_summary/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_drift_summary/index.rst.txt index 475bbbf13..63242a14f 100644 --- a/docs/_sources/autoapi/abacusai/feature_drift_summary/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_drift_summary/index.rst.txt @@ -1,145 +1,26 @@ -abacusai.feature_drift_summary -============================== +:py:mod:`abacusai.feature_drift_summary` +======================================== .. py:module:: abacusai.feature_drift_summary -Classes -------- - -.. autoapisummary:: - - abacusai.feature_drift_summary.CategoricalRangeViolation - abacusai.feature_drift_summary.NullViolation - abacusai.feature_drift_summary.RangeViolation - abacusai.feature_drift_summary.AbstractApiClass - abacusai.feature_drift_summary.FeatureDriftSummary - - Module Contents --------------- -.. py:class:: CategoricalRangeViolation(client, name=None, mostCommonValues=None, freqOutsideTrainingRange=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Summary of important range mismatches for a numerical feature discovered by a model monitoring instance - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: Name of feature. - :type name: str - :param mostCommonValues: List of most common feature names in the prediction distribution not present in the training distribution. - :type mostCommonValues: list[str] - :param freqOutsideTrainingRange: Frequency of prediction rows outside training distribution for the specified feature. - :type freqOutsideTrainingRange: float - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: NullViolation(client, name=None, violation=None, trainingNullFreq=None, predictionNullFreq=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Summary of anomalous null frequencies for a feature discovered by a model monitoring instance - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: Name of feature. - :type name: str - :param violation: Description of null violation for a prediction feature. - :type violation: str - :param trainingNullFreq: Proportion of null entries in training feature. - :type trainingNullFreq: float - :param predictionNullFreq: Proportion of null entries in prediction feature. - :type predictionNullFreq: float - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: RangeViolation(client, name=None, trainingMin=None, trainingMax=None, predictionMin=None, predictionMax=None, freqAboveTrainingRange=None, freqBelowTrainingRange=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Summary of important range mismatches for a numerical feature discovered by a model monitoring instance - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: Name of feature. - :type name: str - :param trainingMin: Minimum value of training distribution for the specified feature. - :type trainingMin: float - :param trainingMax: Maximum value of training distribution for the specified feature. - :type trainingMax: float - :param predictionMin: Minimum value of prediction distribution for the specified feature. - :type predictionMin: float - :param predictionMax: Maximum value of prediction distribution for the specified feature. - :type predictionMax: float - :param freqAboveTrainingRange: Frequency of prediction rows below training minimum for the specified feature. - :type freqAboveTrainingRange: float - :param freqBelowTrainingRange: Frequency of prediction rows above training maximum for the specified feature. - :type freqBelowTrainingRange: float - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_drift_summary.FeatureDriftSummary - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureDriftSummary(client, featureIndex=None, name=None, distance=None, jsDistance=None, wsDistance=None, ksStatistic=None, predictionDrift=None, targetColumn=None, dataIntegrityTimeseries=None, nestedSummary=None, psi=None, csi=None, chiSquare=None, nullViolations={}, rangeViolations={}, catViolations={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Summary of important model monitoring statistics for features available in a model monitoring instance @@ -178,13 +59,11 @@ Module Contents :param catViolations: A list of dicts of categorical feature names and corresponding prediction range discrepancies. :type catViolations: CategoricalRangeViolation - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group/index.rst.txt index 984085742..09f363238 100644 --- a/docs/_sources/autoapi/abacusai/feature_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group/index.rst.txt @@ -1,796 +1,27 @@ -abacusai.feature_group -====================== +:py:mod:`abacusai.feature_group` +================================ .. py:module:: abacusai.feature_group -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group.AnnotationConfig - abacusai.feature_group.MergeConfig - abacusai.feature_group.ProjectFeatureGroupConfig - abacusai.feature_group.SamplingConfig - abacusai.feature_group.CodeSource - abacusai.feature_group.ConcatenationConfig - abacusai.feature_group.Feature - abacusai.feature_group.FeatureGroupTemplate - abacusai.feature_group.FeatureGroupVersion - abacusai.feature_group.IndexingConfig - abacusai.feature_group.NaturalLanguageExplanation - abacusai.feature_group.PointInTimeGroup - abacusai.feature_group.RefreshSchedule - abacusai.feature_group.AbstractApiClass - abacusai.feature_group.FeatureGroup - - -Module Contents ---------------- - -.. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Annotation config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureAnnotationConfigs: List of feature annotation configs - :type featureAnnotationConfigs: list - :param labels: List of labels - :type labels: list - :param statusFeature: Name of the feature that contains the status of the annotation (Optional) - :type statusFeature: str - :param commentsFeatures: Features that contain comments for the annotation (Optional) - :type commentsFeatures: list - :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional) - :type metadataFeature: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: MergeConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the merge config of a feature group - - - .. py:attribute:: merge_mode - :type: abacusai.api_class.enums.MergeMode - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __post_init__() - - -.. py:class:: ProjectFeatureGroupConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for project feature group configuration. - - - .. py:attribute:: type - :type: abacusai.api_class.enums.ProjectConfigType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: SamplingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the sampling config of a feature group - - - .. py:attribute:: sampling_method - :type: abacusai.api_class.enums.SamplingMethodType - - - .. py:method:: _get_builder() - :classmethod: - - - - .. py:method:: __post_init__() - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: ConcatenationConfig(client, concatenatedTable=None, mergeType=None, replaceUntilTimestamp=None, skipMaterialize=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Feature Group Concatenation Config - - :param client: An authenticated API Client instance - :type client: ApiClient - :param concatenatedTable: The feature group to concatenate with the destination feature group. - :type concatenatedTable: str - :param mergeType: The type of merge to perform, either `UNION` or `INTERSECTION`. - :type mergeType: str - :param replaceUntilTimestamp: The Unix timestamp to specify the point up to which data from the source feature group will be replaced. - :type replaceUntilTimestamp: int - :param skipMaterialize: If `True`, the concatenated feature group will not be materialized. - :type skipMaterialize: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Feature(client, name=None, selectClause=None, featureMapping=None, sourceTable=None, originalName=None, usingClause=None, orderClause=None, whereClause=None, featureType=None, dataType=None, detectedFeatureType=None, detectedDataType=None, columns={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature in a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column - :type name: str - :param selectClause: The sql logic for creating this feature's data - :type selectClause: str - :param featureMapping: The Feature Mapping of the feature - :type featureMapping: str - :param sourceTable: The source table of the column - :type sourceTable: str - :param originalName: The original name of the column - :type originalName: str - :param usingClause: Nested Column Using Clause - :type usingClause: str - :param orderClause: Nested Column Ordering Clause - :type orderClause: str - :param whereClause: Nested Column Where Clause - :type whereClause: str - :param featureType: Feature Type of the Feature - :type featureType: str - :param dataType: Data Type of the Feature - :type dataType: str - :param detectedFeatureType: The detected feature type of the column - :type detectedFeatureType: str - :param detectedDataType: The detected data type of the column - :type detectedDataType: str - :param columns: Nested Features - :type columns: NestedFeature - :param pointInTimeInfo: Point in time column information - :type pointInTimeInfo: PointInTimeFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroupTemplate(client, featureGroupTemplateId=None, description=None, featureGroupId=None, isSystemTemplate=None, name=None, templateSql=None, templateVariables=None, createdAt=None, updatedAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A template for creating feature groups. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupTemplateId: The unique identifier for this feature group template. - :type featureGroupTemplateId: str - :param description: A user-friendly text description of this feature group template. - :type description: str - :param featureGroupId: The unique identifier for the feature group used to create this template. - :type featureGroupId: str - :param isSystemTemplate: True if this is a system template returned from a user organization. - :type isSystemTemplate: bool - :param name: The user-friendly name of this feature group template. - :type name: str - :param templateSql: SQL that can include variables which will be replaced by values from the template config to resolve this template SQL into a valid SQL query for a feature group. - :type templateSql: str - :param templateVariables: A map, from template variable names to parameters for replacing those template variables with values (e.g. to values and metadata on how to resolve those values). - :type templateVariables: dict - :param createdAt: When the feature group template was created. - :type createdAt: str - :param updatedAt: When the feature group template was updated. - :type updatedAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete an existing feature group template. - - :param feature_group_template_id: Unique string identifier associated with the feature group template. - :type feature_group_template_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupTemplate - - - - .. py:method:: describe() - - Describe a Feature Group Template. - - :param feature_group_template_id: The unique identifier of a feature group template. - :type feature_group_template_id: str - - :returns: The feature group template object. - :rtype: FeatureGroupTemplate - - - - .. py:method:: update(template_sql = None, template_variables = None, description = None, name = None) - - Update a feature group template. - - :param template_sql: If provided, the new value to use for the template SQL. - :type template_sql: str - :param template_variables: If provided, the new value to use for the template variables. - :type template_variables: list - :param description: Description of this feature group template. - :type description: str - :param name: User-friendly name for this feature group template. - :type name: str - - :returns: The updated feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: preview_resolution(template_bindings = None, template_sql = None, template_variables = None, should_validate = True) - - Resolve template sql using template variables and template bindings. - - :param template_bindings: Values to override the template variable values specified by the template. - :type template_bindings: list - :param template_sql: If specified, use this as the template SQL instead of the feature group template's SQL. - :type template_sql: str - :param template_variables: Template variables to use. If a template is provided, this overrides the template's template variables. - :type template_variables: list - :param should_validate: If true, validates the resolved SQL. - :type should_validate: bool - - :returns: The resolved template - :rtype: ResolvedFeatureGroupTemplate - - - -.. py:class:: FeatureGroupVersion(client, featureGroupVersion=None, featureGroupId=None, sql=None, sourceTables=None, sourceDatasetVersions=None, createdAt=None, status=None, error=None, deployable=None, cpuSize=None, memory=None, useOriginalCsvNames=None, pythonFunctionBindings=None, indexingConfigWarningMsg=None, materializationStartedAt=None, materializationCompletedAt=None, columns=None, templateBindings=None, features={}, pointInTimeGroups={}, codeSource={}, annotationConfig={}, indexingConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A materialized version of a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupVersion: The unique identifier for this materialized version of feature group. - :type featureGroupVersion: str - :param featureGroupId: The unique identifier of the feature group this version belongs to. - :type featureGroupId: str - :param sql: The sql definition creating this feature group. - :type sql: str - :param sourceTables: The source tables for this feature group. - :type sourceTables: list[str] - :param sourceDatasetVersions: The dataset version ids for this feature group version. - :type sourceDatasetVersions: list[str] - :param createdAt: The timestamp at which the feature group version was created. - :type createdAt: str - :param status: The current status of the feature group version. - :type status: str - :param error: Relevant error if the status is FAILED. - :type error: str - :param deployable: whether feature group is deployable or not. - :type deployable: bool - :param cpuSize: Cpu size specified for the python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the python feature group. - :type memory: int - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: list - :param indexingConfigWarningMsg: The warning message related to indexing keys. - :type indexingConfigWarningMsg: str - :param materializationStartedAt: The timestamp at which the feature group materialization started. - :type materializationStartedAt: str - :param materializationCompletedAt: The timestamp at which the feature group materialization completed. - :type materializationCompletedAt: str - :param columns: List of resolved columns. - :type columns: list[feature] - :param templateBindings: Template variable bindings used for resolving the template. - :type templateBindings: list - :param features: List of features. - :type features: Feature - :param pointInTimeGroups: List of Point In Time Groups - :type pointInTimeGroups: PointInTimeGroup - :param codeSource: If a python feature group, information on the source code - :type codeSource: CodeSource - :param annotationConfig: The annotations config for the feature group. - :type annotationConfig: AnnotationConfig - :param indexingConfig: The indexing config for the feature group. - :type indexingConfig: IndexingConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: create_snapshot_feature_group(table_name) - - Creates a Snapshot Feature Group corresponding to a specific Feature Group version. - - :param table_name: Name for the newly created Snapshot Feature Group table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - - :returns: Feature Group corresponding to the newly created Snapshot. - :rtype: FeatureGroup - - - - .. py:method:: export_to_file_connector(location, export_file_format, overwrite = False) - - Export Feature group to File Connector. - - :param location: Cloud file location to export to. - :type location: str - :param export_file_format: Enum string specifying the file format to export to. - :type export_file_format: str - :param overwrite: If true and a file exists at this location, this process will overwrite the file. - :type overwrite: bool - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_database_connector(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) - - Export Feature group to Database Connector. - - :param database_connector_id: Unique string identifier for the Database Connector to export to. - :type database_connector_id: str - :param object_name: Name of the database object to write to. - :type object_name: str - :param write_mode: Enum string indicating whether to use INSERT or UPSERT. - :type write_mode: str - :param database_feature_mapping: Key/value pair JSON object of "database connector column" -> "feature name" pairs. - :type database_feature_mapping: dict - :param id_column: Required if write_mode is UPSERT. Indicates which database column should be used as the lookup key. - :type id_column: str - :param additional_id_columns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additional_id_columns: list - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_console(export_file_format) - - Export Feature group to console. - - :param export_file_format: File format to export to. - :type export_file_format: str - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: get_materialization_logs(stdout = False, stderr = False) - - Returns logs for a materialized feature group version. - - :param stdout: Set to True to get info logs. - :type stdout: bool - :param stderr: Set to True to get error logs. - :type stderr: bool - - :returns: A function logs object. - :rtype: FunctionLogs - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupVersion - - - - .. py:method:: describe() - - Describe a feature group version. - - :param feature_group_version: The unique identifier associated with the feature group version. - :type feature_group_version: str - - :returns: The feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) - - Get metrics for a specific feature group version. - - :param selected_columns: A list of columns to order first. - :type selected_columns: List - :param include_charts: A flag indicating whether charts should be included in the response. Default is false. - :type include_charts: bool - :param include_statistics: A flag indicating whether statistics should be included in the response. Default is true. - :type include_statistics: bool - - :returns: The metrics for the specified feature group version. - :rtype: DataMetrics - - - - .. py:method:: get_logs() - - Retrieves the feature group materialization logs. - - :param feature_group_version: The unique version ID of the feature group version. - :type feature_group_version: str - - :returns: The logs for the specified feature group version. - :rtype: FeatureGroupVersionLogs - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until feature group version is materialized - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout=3600) - - A waiting call until feature group version is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the feature group version. - - :returns: A string describing the status of a feature group version (pending, complete, etc.). - :rtype: str - - - - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) - - - .. py:method:: load_as_pandas(max_workers=10) - - Loads the feature group version into a pandas dataframe. - - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe displaying the data in the feature group version. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column, max_workers=10) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - -.. py:class:: IndexingConfig(client, primaryKey=None, updateTimestampKey=None, lookupKeys=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The indexing config for a Feature Group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param primaryKey: A single key index - :type primaryKey: str - :param updateTimestampKey: The primary timestamp feature - :type updateTimestampKey: str - :param lookupKeys: A multi-key index. Cannot be used in conjuction with primary key. - :type lookupKeys: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: NaturalLanguageExplanation(client, shortExplanation=None, longExplanation=None, isOutdated=None, htmlExplanation=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Natural language explanation of an artifact/object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param shortExplanation: succinct explanation of the artifact - :type shortExplanation: str - :param longExplanation: Longer and verbose explanation of the artifact - :type longExplanation: str - :param isOutdated: Flag indicating whether the explanation is outdated due to a change in the underlying artifact - :type isOutdated: bool - :param htmlExplanation: HTML formatted explanation of the artifact - :type htmlExplanation: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PointInTimeGroup(client, groupName=None, windowKey=None, aggregationKeys=None, lookbackWindow=None, lookbackWindowLag=None, lookbackCount=None, lookbackUntilPosition=None, historyTableName=None, historyWindowKey=None, historyAggregationKeys=None, features={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point in time group containing point in time features - - :param client: An authenticated API Client instance - :type client: ApiClient - :param groupName: The name of the point in time group - :type groupName: str - :param windowKey: Name of feature which contains the timestamp value for the point in time feature - :type windowKey: str - :param aggregationKeys: List of keys to use for join the historical table and performing the window aggregation. - :type aggregationKeys: list - :param lookbackWindow: Number of seconds in the past from the current time for start of the window. - :type lookbackWindow: float - :param lookbackWindowLag: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the "future" rows in the history table. - :type lookbackWindowLag: float - :param lookbackCount: If window is specified in terms of count, the start position of the window (0 is the current row) - :type lookbackCount: int - :param lookbackUntilPosition: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookbackUntilPosition: int - :param historyTableName: The table to use for aggregating, if not provided, the source table will be used - :type historyTableName: str - :param historyWindowKey: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used - :type historyWindowKey: str - :param historyAggregationKeys: List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys - :type historyAggregationKeys: list - :param features: List of features in the Point in Time group - :type features: PointInTimeGroupFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - +Module Contents +--------------- -.. py:class:: AbstractApiClass(client, id) +Classes +~~~~~~~ - .. py:method:: __eq__(other) +.. autoapisummary:: - Return self==value. + abacusai.feature_group.FeatureGroup - .. py:method:: _get_attribute_as_dict(attribute) +.. py:class:: FeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}, operatorConfig={}) -.. py:class:: FeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}) Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - A feature group. :param client: An authenticated API Client instance @@ -839,8 +70,6 @@ Module Contents :type incremental: bool :param mergeConfig: Merge configuration settings for the feature group. :type mergeConfig: dict - :param operatorConfig: Operator configuration settings for the feature group. - :type operatorConfig: dict :param samplingConfig: Sampling configuration for the feature group. :type samplingConfig: dict :param cpuSize: CPU size specified for the Python feature group. @@ -887,14 +116,14 @@ Module Contents :type explanation: NaturalLanguageExplanation :param refreshSchedules: List of schedules that determines when the next version of the feature group will be created. :type refreshSchedules: RefreshSchedule - + :param operatorConfig: Operator configuration settings for the feature group. + :type operatorConfig: OperatorConfig .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -903,7 +132,6 @@ Module Contents :rtype: dict - .. py:method:: add_to_project(project_id, feature_group_type = 'CUSTOM_TABLE') Adds a feature group to a project. @@ -914,7 +142,6 @@ Module Contents :type feature_group_type: str - .. py:method:: set_project_config(project_id, project_config = None) Sets a feature group's project config @@ -925,7 +152,6 @@ Module Contents :type project_config: ProjectFeatureGroupConfig - .. py:method:: get_project_config(project_id) Gets a feature group's project config @@ -937,7 +163,6 @@ Module Contents :rtype: ProjectConfig - .. py:method:: remove_from_project(project_id) Removes a feature group from a project. @@ -946,7 +171,6 @@ Module Contents :type project_id: str - .. py:method:: set_type(project_id, feature_group_type = 'CUSTOM_TABLE') Update the feature group type in a project. The feature group must already be added to the project. @@ -957,7 +181,6 @@ Module Contents :type feature_group_type: str - .. py:method:: describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) Get the latest annotation entry for a given feature group, feature, and document. @@ -973,7 +196,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: verify_and_describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) Get the latest annotation entry for a given feature group, feature, and document along with verification information. @@ -989,7 +211,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: update_annotation_status(feature_name, status, doc_id = None, feature_group_row_identifier = None, save_metadata = False) Update the status of an annotation entry. @@ -1009,7 +230,6 @@ Module Contents :rtype: AnnotationEntry - .. py:method:: get_document_to_annotate(project_id, feature_name, feature_group_row_identifier = None, get_previous = False) Get an available document that needs to be annotated for a annotation feature group. @@ -1027,7 +247,6 @@ Module Contents :rtype: AnnotationDocument - .. py:method:: get_annotations_status(feature_name = None, check_for_materialization = False) Get the status of the annotations for a given feature group and feature. @@ -1041,7 +260,6 @@ Module Contents :rtype: AnnotationsStatus - .. py:method:: import_annotation_labels(file, annotation_type) Imports annotation labels from csv file. All valid values in the file will be imported as labels (including header row if present). @@ -1055,7 +273,6 @@ Module Contents :rtype: AnnotationConfig - .. py:method:: create_sampling(table_name, sampling_config, description = None) Creates a new Feature Group defined as a sample of rows from another Feature Group. @@ -1074,7 +291,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_sampling_config(sampling_config) Set a FeatureGroup’s sampling to the config values provided, so that the rows the FeatureGroup returns will be a sample of those it would otherwise have returned. @@ -1086,7 +302,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_merge_config(merge_config) Set a MergeFeatureGroup’s merge config to the values provided, so that the feature group only returns a bounded range of an incremental dataset. @@ -1098,14 +313,15 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_operator_config(operator_config) Set a OperatorFeatureGroup’s operator config to the values provided. :param operator_config: A dictionary object specifying the pre-defined operations. - :type operator_config: dict + :type operator_config: OperatorConfig + :returns: The updated FeatureGroup. + :rtype: FeatureGroup .. py:method:: set_schema(schema) @@ -1116,7 +332,6 @@ Module Contents :type schema: list - .. py:method:: get_schema(project_id = None) Returns a schema for a given FeatureGroup in a project. @@ -1128,7 +343,6 @@ Module Contents :rtype: list[Feature] - .. py:method:: create_feature(name, select_expression) Creates a new feature in a Feature Group from a SQL select statement. @@ -1142,7 +356,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: add_tag(tag) Adds a tag to the feature group @@ -1151,7 +364,6 @@ Module Contents :type tag: str - .. py:method:: remove_tag(tag) Removes a tag from the specified feature group. @@ -1160,7 +372,6 @@ Module Contents :type tag: str - .. py:method:: add_annotatable_feature(name, annotation_type) Add an annotatable feature in a Feature Group @@ -1174,7 +385,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_as_annotatable_feature(feature_name, annotation_type, feature_group_row_identifier_feature = None, doc_id_feature = None) Sets an existing feature as an annotatable feature (Feature that can be annotated). @@ -1192,7 +402,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_annotation_status_feature(feature_name) Sets a feature as the annotation status feature for a feature group. @@ -1204,7 +413,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: unset_feature_as_annotatable_feature(feature_name) Unsets a feature as annotatable @@ -1216,7 +424,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: add_annotation_label(label_name, annotation_type, label_definition = None) Adds an annotation label @@ -1232,7 +439,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: remove_annotation_label(label_name) Removes an annotation label @@ -1244,7 +450,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: add_feature_tag(feature, tag) Adds a tag on a feature @@ -1255,7 +460,6 @@ Module Contents :type tag: str - .. py:method:: remove_feature_tag(feature, tag) Removes a tag from a feature @@ -1266,7 +470,6 @@ Module Contents :type tag: str - .. py:method:: create_nested_feature(nested_feature_name, table_name, using_clause, where_clause = None, order_clause = None) Creates a new nested feature in a feature group from a SQL statement. @@ -1286,7 +489,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_nested_feature(nested_feature_name, table_name = None, using_clause = None, where_clause = None, order_clause = None, new_nested_feature_name = None) Updates a previously existing nested feature in a feature group. @@ -1308,7 +510,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: delete_nested_feature(nested_feature_name) Delete a nested feature. @@ -1320,7 +521,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_feature(feature_name, history_table_name, aggregation_keys, timestamp_key, historical_timestamp_key, expression, lookback_window_seconds = None, lookback_window_lag_seconds = 0, lookback_count = None, lookback_until_position = 0) Creates a new point in time feature in a feature group using another historical feature group, window spec, and aggregate expression. @@ -1355,7 +555,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_feature(feature_name, history_table_name = None, aggregation_keys = None, timestamp_key = None, historical_timestamp_key = None, expression = None, lookback_window_seconds = None, lookback_window_lag_seconds = None, lookback_count = None, lookback_until_position = None, new_feature_name = None) Updates an existing Point-in-Time (PiT) feature in a feature group. See `createPointInTimeFeature` for detailed semantics. @@ -1387,7 +586,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_group(group_name, window_key, aggregation_keys, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = 0, lookback_count = None, lookback_until_position = 0) Create a Point-in-Time Group @@ -1417,7 +615,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: generate_point_in_time_features(group_name, columns, window_functions, prefix = None) Generates and adds PIT features given the selected columns to aggregate over, and the operations to include. @@ -1435,7 +632,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_group(group_name, window_key = None, aggregation_keys = None, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = None, lookback_count = None, lookback_until_position = None) Update Point-in-Time Group @@ -1465,7 +661,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: delete_point_in_time_group(group_name) Delete point in time group @@ -1477,7 +672,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_group_feature(group_name, name, expression) Create point in time group feature @@ -1493,7 +687,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_group_feature(group_name, name, expression) Update a feature's SQL expression in a point in time group @@ -1509,7 +702,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_feature_type(feature, feature_type, project_id = None) Set the type of a feature in a feature group. Specify the feature group ID, feature name, and feature type, and the method will return the new column with the changes reflected. @@ -1525,7 +717,6 @@ Module Contents :rtype: Schema - .. py:method:: invalidate_streaming_data(invalid_before_timestamp) Invalidates all streaming data with timestamp before invalidBeforeTimestamp @@ -1534,7 +725,6 @@ Module Contents :type invalid_before_timestamp: int - .. py:method:: concatenate_data(source_feature_group_id, merge_type = 'UNION', replace_until_timestamp = None, skip_materialize = False) Concatenates data from one Feature Group to another. Feature Groups can be merged if their schemas are compatible, they have the special `updateTimestampKey` column, and (if set) the `primaryKey` column. The second operand in the concatenate operation will be appended to the first operand (merge target). @@ -1549,7 +739,6 @@ Module Contents :type skip_materialize: bool - .. py:method:: remove_concatenation_config() Removes the concatenation config on a destination feature group. @@ -1558,7 +747,6 @@ Module Contents :type feature_group_id: str - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -1567,7 +755,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: describe() Describe a Feature Group. @@ -1579,7 +766,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: set_indexing_config(primary_key = None, update_timestamp_key = None, lookup_keys = None) Sets various attributes of the feature group used for primary key, deployment lookups and streaming updates. @@ -1592,7 +778,6 @@ Module Contents :type lookup_keys: list - .. py:method:: update(description = None) Modify an existing Feature Group. @@ -1604,7 +789,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: detach_from_template() Update a feature group to detach it from a template. @@ -1616,7 +800,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_template_bindings(template_bindings = None) Update the feature group template bindings for a template feature group. @@ -1628,7 +811,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_python_function_bindings(python_function_bindings) Updates an existing Feature Group's Python function bindings from a user-provided Python Function. If a list of feature groups are supplied within the Python function bindings, we will provide DataFrames (Pandas in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. @@ -1637,7 +819,6 @@ Module Contents :type python_function_bindings: List - .. py:method:: update_python_function(python_function_name, python_function_bindings = None, cpu_size = None, memory = None, use_gpu = None, use_original_csv_names = None) Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function @@ -1651,16 +832,15 @@ Module Contents :param python_function_bindings: List of python function arguments. :type python_function_bindings: List :param cpu_size: Size of the CPU for the feature group python function. - :type cpu_size: str + :type cpu_size: CPUSize :param memory: Memory (in GB) for the feature group python function. - :type memory: int + :type memory: MemorySize :param use_gpu: Whether the feature group needs a gpu or not. Otherwise default to CPU. :type use_gpu: bool :param use_original_csv_names: If enabled, it uses the original column names for input feature groups from CSV datasets. :type use_original_csv_names: bool - .. py:method:: update_sql_definition(sql) Updates the SQL statement for a feature group. @@ -1672,7 +852,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_dataset_feature_expression(feature_expression) Updates the SQL feature expression for a Dataset FeatureGroup's custom features @@ -1684,7 +863,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: update_feature(name, select_expression = None, new_name = None) Modifies an existing feature in a feature group. @@ -1700,7 +878,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: list_exports() Lists all of the feature group exports for the feature group @@ -1712,7 +889,6 @@ Module Contents :rtype: list[FeatureGroupExport] - .. py:method:: set_modifier_lock(locked = True) Lock a feature group to prevent modification. @@ -1721,7 +897,6 @@ Module Contents :type locked: bool - .. py:method:: list_modifiers() List the users who can modify a given feature group. @@ -1733,7 +908,6 @@ Module Contents :rtype: ModificationLockInfo - .. py:method:: add_user_to_modifiers(email) Adds a user to a feature group. @@ -1742,7 +916,6 @@ Module Contents :type email: str - .. py:method:: add_organization_group_to_modifiers(organization_group_id) Add OrganizationGroup to a feature group modifiers list @@ -1751,7 +924,6 @@ Module Contents :type organization_group_id: str - .. py:method:: remove_user_from_modifiers(email) Removes a user from a specified feature group. @@ -1760,7 +932,6 @@ Module Contents :type email: str - .. py:method:: remove_organization_group_from_modifiers(organization_group_id) Removes an OrganizationGroup from a feature group modifiers list @@ -1769,7 +940,6 @@ Module Contents :type organization_group_id: str - .. py:method:: delete_feature(name) Removes a feature from the feature group. @@ -1781,7 +951,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: delete() Deletes a Feature Group. @@ -1790,7 +959,6 @@ Module Contents :type feature_group_id: str - .. py:method:: create_version(variable_bindings = None) Creates a snapshot for a specified feature group. Triggers materialization of the feature group. The new version of the feature group is created after it has materialized. @@ -1802,7 +970,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: list_versions(limit = 100, start_after_version = None) Retrieves a list of all feature group versions for the specified feature group. @@ -1816,7 +983,6 @@ Module Contents :rtype: list[FeatureGroupVersion] - .. py:method:: create_template(name, template_sql, template_variables, description = None, template_bindings = None, should_attach_feature_group_to_template = False) Create a feature group template. @@ -1838,7 +1004,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: suggest_template_for() Suggest values for a feature gruop template, based on a feature group. @@ -1850,7 +1015,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: get_recent_streamed_data() Returns recently streamed data to a streaming feature group. @@ -1859,7 +1023,6 @@ Module Contents :type feature_group_id: str - .. py:method:: append_data(streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -1870,7 +1033,6 @@ Module Contents :type data: dict - .. py:method:: append_multiple_data(streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -1881,7 +1043,6 @@ Module Contents :type data: list - .. py:method:: upsert_data(data, streaming_token = None) Update new data into the feature group for a given lookup key record ID if the record ID is found; otherwise, insert new data into the feature group. @@ -1895,7 +1056,6 @@ Module Contents :rtype: FeatureGroupRow - .. py:method:: delete_data(primary_key) Deletes a row from the feature group given the primary key @@ -1904,7 +1064,6 @@ Module Contents :type primary_key: str - .. py:method:: get_data(primary_key = None, num_rows = None) Gets the feature group rows for online updatable feature groups. @@ -1922,7 +1081,6 @@ Module Contents :rtype: list[FeatureGroupRow] - .. py:method:: get_natural_language_explanation(feature_group_version = None, model_id = None) Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model @@ -1936,7 +1094,6 @@ Module Contents :rtype: NaturalLanguageExplanation - .. py:method:: generate_natural_language_explanation(feature_group_version = None, model_id = None) Generates natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model @@ -1950,7 +1107,6 @@ Module Contents :rtype: NaturalLanguageExplanation - .. py:method:: wait_for_dataset(timeout = 7200) A waiting call until the feature group's dataset, if any, is ready for use. @@ -1959,7 +1115,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_upload(timeout = 7200) Waits for a feature group created from a dataframe to be ready for materialization and version creation. @@ -1968,7 +1123,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_materialization(timeout = 7200) A waiting call until feature group is materialized. @@ -1977,7 +1131,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_streaming_ready(timeout = 600) Waits for the feature group indexing config to be applied for streaming @@ -1986,7 +1139,6 @@ Module Contents :type timeout: int - .. py:method:: get_status(streaming_status = False) Gets the status of the feature group. @@ -1995,7 +1147,6 @@ Module Contents :rtype: str - .. py:method:: load_as_pandas() Loads the feature groups into a python pandas dataframe. @@ -2004,7 +1155,6 @@ Module Contents :rtype: DataFrame - .. py:method:: load_as_pandas_documents(doc_id_column, document_column) Loads a feature group with documents data into a pandas dataframe. @@ -2018,7 +1168,6 @@ Module Contents :rtype: DataFrame - .. py:method:: describe_dataset() Displays the dataset attached to a feature group. @@ -2027,7 +1176,6 @@ Module Contents :rtype: Dataset - .. py:method:: materialize() Materializes the feature group's latest change at the api call time. It'll skip materialization if no change since the current latest version. diff --git a/docs/_sources/autoapi/abacusai/feature_group_document/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_document/index.rst.txt index c2bae55da..61d405efe 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_document/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_document/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_document -=============================== +:py:mod:`abacusai.feature_group_document` +========================================= .. py:module:: abacusai.feature_group_document -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_document.AbstractApiClass - abacusai.feature_group_document.FeatureGroupDocument - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_document.FeatureGroupDocument - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupDocument(client, featureGroupId=None, docId=None, status=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A document of a feature group. @@ -43,13 +33,11 @@ Module Contents :param status: The status of the document processing :type status: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_export/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_export/index.rst.txt index b69f90a60..4156bbc99 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_export/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_export/index.rst.txt @@ -1,67 +1,26 @@ -abacusai.feature_group_export -============================= +:py:mod:`abacusai.feature_group_export` +======================================= .. py:module:: abacusai.feature_group_export -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_export.ProjectConfig - abacusai.feature_group_export.AbstractApiClass - abacusai.feature_group_export.FeatureGroupExport - - Module Contents --------------- -.. py:class:: ProjectConfig(client, type=None, config={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Project-specific config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: Type of project config - :type type: str - :param config: Project-specific config for this feature group - :type config: ProjectFeatureGroupConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_export.FeatureGroupExport - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupExport(client, featureGroupExportId=None, failedWrites=None, totalWrites=None, featureGroupVersion=None, connectorType=None, outputLocation=None, fileFormat=None, databaseConnectorId=None, objectName=None, writeMode=None, databaseFeatureMapping=None, idColumn=None, status=None, createdAt=None, exportCompletedAt=None, additionalIdColumns=None, error=None, databaseOutputError=None, projectConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A feature Group Export Job @@ -106,13 +65,11 @@ Module Contents :param projectConfig: Project config for this feature group. :type projectConfig: ProjectConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -121,7 +78,6 @@ Module Contents :rtype: dict - .. py:method:: get_feature_group_version_export_download_url() Get a link to download the feature group version. @@ -133,7 +89,6 @@ Module Contents :rtype: FeatureGroupExportDownloadUrl - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -142,7 +97,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: describe() A feature group export @@ -154,7 +108,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: get_connector_errors() Returns a stream containing the write errors of the feature group export database connection, if any writes failed to the database connector. @@ -163,7 +116,6 @@ Module Contents :type feature_group_export_id: str - .. py:method:: wait_for_results(timeout=3600) A waiting call until feature group export is created. @@ -172,7 +124,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_export(timeout=3600) A waiting call until feature group export is created. @@ -181,7 +132,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the feature group export. diff --git a/docs/_sources/autoapi/abacusai/feature_group_export_config/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_export_config/index.rst.txt index c5e363988..d2d5072de 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_export_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_export_config/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_export_config -==================================== +:py:mod:`abacusai.feature_group_export_config` +============================================== .. py:module:: abacusai.feature_group_export_config -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_export_config.AbstractApiClass - abacusai.feature_group_export_config.FeatureGroupExportConfig - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_export_config.FeatureGroupExportConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupExportConfig(client, outputLocation=None, fileFormat=None, databaseConnectorId=None, objectName=None, writeMode=None, databaseFeatureMapping=None, idColumn=None, additionalIdColumns=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Export configuration (file connector or database connector information) for feature group exports. @@ -53,13 +43,11 @@ Module Contents :param additionalIdColumns: For database connectors which support it, additional ID columns to use as a complex key for upserting. :type additionalIdColumns: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_export_download_url/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_export_download_url/index.rst.txt index fee7b730c..0fc718985 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_export_download_url/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_export_download_url/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_export_download_url -========================================== +:py:mod:`abacusai.feature_group_export_download_url` +==================================================== .. py:module:: abacusai.feature_group_export_download_url -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_export_download_url.AbstractApiClass - abacusai.feature_group_export_download_url.FeatureGroupExportDownloadUrl - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_export_download_url.FeatureGroupExportDownloadUrl - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupExportDownloadUrl(client, downloadUrl=None, expiresAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Feature Group Export Download Url, which is used to download the feature group version @@ -41,13 +31,11 @@ Module Contents :param expiresAt: String representation of the ISO-8601 datetime when the URL expires. :type expiresAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_lineage/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_lineage/index.rst.txt index 5c837c777..53eb7018d 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_lineage/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_lineage/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_lineage -============================== +:py:mod:`abacusai.feature_group_lineage` +======================================== .. py:module:: abacusai.feature_group_lineage -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_lineage.AbstractApiClass - abacusai.feature_group_lineage.FeatureGroupLineage - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_lineage.FeatureGroupLineage - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupLineage(client, nodes=None, connections=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Directed acyclic graph of feature group lineage for all feature groups in a project @@ -41,13 +31,11 @@ Module Contents :param connections: A list of connections in the graph between nodes :type connections: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_refresh_export_config/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_refresh_export_config/index.rst.txt index 7b1f36d90..401eceade 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_refresh_export_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_refresh_export_config/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_refresh_export_config -============================================ +:py:mod:`abacusai.feature_group_refresh_export_config` +====================================================== .. py:module:: abacusai.feature_group_refresh_export_config -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_refresh_export_config.AbstractApiClass - abacusai.feature_group_refresh_export_config.FeatureGroupRefreshExportConfig - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_refresh_export_config.FeatureGroupRefreshExportConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupRefreshExportConfig(client, connectorType=None, location=None, exportFileFormat=None, additionalIdColumns=None, databaseFeatureMapping=None, externalConnectionId=None, idColumn=None, objectName=None, writeMode=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Feature Group Refresh Export Config outlines the export configuration for a feature group. @@ -55,13 +45,11 @@ Module Contents :param writeMode: The write mode to use for the export :type writeMode: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_row/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_row/index.rst.txt index 0946bbf26..039f745d3 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_row/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_row/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_row -========================== +:py:mod:`abacusai.feature_group_row` +==================================== .. py:module:: abacusai.feature_group_row -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_row.AbstractApiClass - abacusai.feature_group_row.FeatureGroupRow - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_row.FeatureGroupRow - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupRow(client, featureGroupId=None, primaryKey=None, createdAt=None, updatedAt=None, contents=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A row of a feature group. @@ -47,13 +37,11 @@ Module Contents :param contents: A dictionary of feature names and values for this row. :type contents: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_row_process/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_row_process/index.rst.txt index 7dfb9e43a..25e32dedd 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_row_process/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_row_process/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_row_process -================================== +:py:mod:`abacusai.feature_group_row_process` +============================================ .. py:module:: abacusai.feature_group_row_process -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_row_process.AbstractApiClass - abacusai.feature_group_row_process.FeatureGroupRowProcess - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_row_process.FeatureGroupRowProcess - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupRowProcess(client, featureGroupId=None, deploymentId=None, primaryKeyValue=None, featureGroupRowProcessId=None, createdAt=None, updatedAt=None, startedAt=None, completedAt=None, timeoutAt=None, retriesRemaining=None, totalAttemptsAllowed=None, status=None, error=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A feature group row process @@ -63,13 +53,11 @@ Module Contents :param error: The error message if the status is FAILED. :type error: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -78,7 +66,6 @@ Module Contents :rtype: dict - .. py:method:: wait_for_process(timeout=1200) A waiting call until model monitor version is ready. @@ -87,7 +74,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the feature group row process. diff --git a/docs/_sources/autoapi/abacusai/feature_group_row_process_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_row_process_logs/index.rst.txt index a53409fdb..794a5a3aa 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_row_process_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_row_process_logs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_row_process_logs -======================================= +:py:mod:`abacusai.feature_group_row_process_logs` +================================================= .. py:module:: abacusai.feature_group_row_process_logs -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_row_process_logs.AbstractApiClass - abacusai.feature_group_row_process_logs.FeatureGroupRowProcessLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_row_process_logs.FeatureGroupRowProcessLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupRowProcessLogs(client, logs=None, featureGroupId=None, deploymentId=None, primaryKeyValue=None, featureGroupRowProcessId=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs for the feature group row process. @@ -47,13 +37,11 @@ Module Contents :param featureGroupRowProcessId: The ID of the feature group row process. :type featureGroupRowProcessId: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_row_process_summary/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_row_process_summary/index.rst.txt index 20b95c919..48a2fe6a2 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_row_process_summary/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_row_process_summary/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_row_process_summary -========================================== +:py:mod:`abacusai.feature_group_row_process_summary` +==================================================== .. py:module:: abacusai.feature_group_row_process_summary -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_row_process_summary.AbstractApiClass - abacusai.feature_group_row_process_summary.FeatureGroupRowProcessSummary - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_row_process_summary.FeatureGroupRowProcessSummary - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupRowProcessSummary(client, totalProcesses=None, pendingProcesses=None, processingProcesses=None, completeProcesses=None, failedProcesses=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A summary of the feature group processes for a deployment. @@ -47,13 +37,11 @@ Module Contents :param failedProcesses: The number of failed processes :type failedProcesses: int - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_template/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_template/index.rst.txt index 245d314c5..2b1388d66 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_template/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_template/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_template -=============================== +:py:mod:`abacusai.feature_group_template` +========================================= .. py:module:: abacusai.feature_group_template -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_template.AbstractApiClass - abacusai.feature_group_template.FeatureGroupTemplate - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_template.FeatureGroupTemplate - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupTemplate(client, featureGroupTemplateId=None, description=None, featureGroupId=None, isSystemTemplate=None, name=None, templateSql=None, templateVariables=None, createdAt=None, updatedAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A template for creating feature groups. @@ -55,13 +45,11 @@ Module Contents :param updatedAt: When the feature group template was updated. :type updatedAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -70,7 +58,6 @@ Module Contents :rtype: dict - .. py:method:: delete() Delete an existing feature group template. @@ -79,7 +66,6 @@ Module Contents :type feature_group_template_id: str - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -88,7 +74,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: describe() Describe a Feature Group Template. @@ -100,7 +85,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: update(template_sql = None, template_variables = None, description = None, name = None) Update a feature group template. @@ -118,7 +102,6 @@ Module Contents :rtype: FeatureGroupTemplate - .. py:method:: preview_resolution(template_bindings = None, template_sql = None, template_variables = None, should_validate = True) Resolve template sql using template variables and template bindings. diff --git a/docs/_sources/autoapi/abacusai/feature_group_template_variable_options/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_template_variable_options/index.rst.txt index 77c966e56..3e6850660 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_template_variable_options/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_template_variable_options/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_template_variable_options -================================================ +:py:mod:`abacusai.feature_group_template_variable_options` +========================================================== .. py:module:: abacusai.feature_group_template_variable_options -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_template_variable_options.AbstractApiClass - abacusai.feature_group_template_variable_options.FeatureGroupTemplateVariableOptions - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_template_variable_options.FeatureGroupTemplateVariableOptions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupTemplateVariableOptions(client, templateVariableOptions=None, userFeedback=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Feature Group Template Variable Options @@ -41,13 +31,11 @@ Module Contents :param userFeedback: List of additional information regarding variable options for the user. :type userFeedback: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_group_version/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_version/index.rst.txt index 525c8518e..953d50d35 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_version/index.rst.txt @@ -1,261 +1,26 @@ -abacusai.feature_group_version -============================== +:py:mod:`abacusai.feature_group_version` +======================================== .. py:module:: abacusai.feature_group_version -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_version.AnnotationConfig - abacusai.feature_group_version.CodeSource - abacusai.feature_group_version.Feature - abacusai.feature_group_version.IndexingConfig - abacusai.feature_group_version.PointInTimeGroup - abacusai.feature_group_version.AbstractApiClass - abacusai.feature_group_version.FeatureGroupVersion - - Module Contents --------------- -.. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Annotation config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureAnnotationConfigs: List of feature annotation configs - :type featureAnnotationConfigs: list - :param labels: List of labels - :type labels: list - :param statusFeature: Name of the feature that contains the status of the annotation (Optional) - :type statusFeature: str - :param commentsFeatures: Features that contain comments for the annotation (Optional) - :type commentsFeatures: list - :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional) - :type metadataFeature: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: Feature(client, name=None, selectClause=None, featureMapping=None, sourceTable=None, originalName=None, usingClause=None, orderClause=None, whereClause=None, featureType=None, dataType=None, detectedFeatureType=None, detectedDataType=None, columns={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature in a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column - :type name: str - :param selectClause: The sql logic for creating this feature's data - :type selectClause: str - :param featureMapping: The Feature Mapping of the feature - :type featureMapping: str - :param sourceTable: The source table of the column - :type sourceTable: str - :param originalName: The original name of the column - :type originalName: str - :param usingClause: Nested Column Using Clause - :type usingClause: str - :param orderClause: Nested Column Ordering Clause - :type orderClause: str - :param whereClause: Nested Column Where Clause - :type whereClause: str - :param featureType: Feature Type of the Feature - :type featureType: str - :param dataType: Data Type of the Feature - :type dataType: str - :param detectedFeatureType: The detected feature type of the column - :type detectedFeatureType: str - :param detectedDataType: The detected data type of the column - :type detectedDataType: str - :param columns: Nested Features - :type columns: NestedFeature - :param pointInTimeInfo: Point in time column information - :type pointInTimeInfo: PointInTimeFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: IndexingConfig(client, primaryKey=None, updateTimestampKey=None, lookupKeys=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The indexing config for a Feature Group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param primaryKey: A single key index - :type primaryKey: str - :param updateTimestampKey: The primary timestamp feature - :type updateTimestampKey: str - :param lookupKeys: A multi-key index. Cannot be used in conjuction with primary key. - :type lookupKeys: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PointInTimeGroup(client, groupName=None, windowKey=None, aggregationKeys=None, lookbackWindow=None, lookbackWindowLag=None, lookbackCount=None, lookbackUntilPosition=None, historyTableName=None, historyWindowKey=None, historyAggregationKeys=None, features={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point in time group containing point in time features - - :param client: An authenticated API Client instance - :type client: ApiClient - :param groupName: The name of the point in time group - :type groupName: str - :param windowKey: Name of feature which contains the timestamp value for the point in time feature - :type windowKey: str - :param aggregationKeys: List of keys to use for join the historical table and performing the window aggregation. - :type aggregationKeys: list - :param lookbackWindow: Number of seconds in the past from the current time for start of the window. - :type lookbackWindow: float - :param lookbackWindowLag: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the "future" rows in the history table. - :type lookbackWindowLag: float - :param lookbackCount: If window is specified in terms of count, the start position of the window (0 is the current row) - :type lookbackCount: int - :param lookbackUntilPosition: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookbackUntilPosition: int - :param historyTableName: The table to use for aggregating, if not provided, the source table will be used - :type historyTableName: str - :param historyWindowKey: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used - :type historyWindowKey: str - :param historyAggregationKeys: List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys - :type historyAggregationKeys: list - :param features: List of features in the Point in Time group - :type features: PointInTimeGroupFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_version.FeatureGroupVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupVersion(client, featureGroupVersion=None, featureGroupId=None, sql=None, sourceTables=None, sourceDatasetVersions=None, createdAt=None, status=None, error=None, deployable=None, cpuSize=None, memory=None, useOriginalCsvNames=None, pythonFunctionBindings=None, indexingConfigWarningMsg=None, materializationStartedAt=None, materializationCompletedAt=None, columns=None, templateBindings=None, features={}, pointInTimeGroups={}, codeSource={}, annotationConfig={}, indexingConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A materialized version of a feature group @@ -308,13 +73,11 @@ Module Contents :param indexingConfig: The indexing config for the feature group. :type indexingConfig: IndexingConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -323,7 +86,6 @@ Module Contents :rtype: dict - .. py:method:: create_snapshot_feature_group(table_name) Creates a Snapshot Feature Group corresponding to a specific Feature Group version. @@ -335,7 +97,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: export_to_file_connector(location, export_file_format, overwrite = False) Export Feature group to File Connector. @@ -351,7 +112,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: export_to_database_connector(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) Export Feature group to Database Connector. @@ -373,7 +133,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: export_to_console(export_file_format) Export Feature group to console. @@ -385,7 +144,6 @@ Module Contents :rtype: FeatureGroupExport - .. py:method:: get_materialization_logs(stdout = False, stderr = False) Returns logs for a materialized feature group version. @@ -399,7 +157,6 @@ Module Contents :rtype: FunctionLogs - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -408,7 +165,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: describe() Describe a feature group version. @@ -420,7 +176,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) Get metrics for a specific feature group version. @@ -436,7 +191,6 @@ Module Contents :rtype: DataMetrics - .. py:method:: get_logs() Retrieves the feature group materialization logs. @@ -448,7 +202,6 @@ Module Contents :rtype: FeatureGroupVersionLogs - .. py:method:: wait_for_results(timeout=3600) A waiting call until feature group version is materialized @@ -457,7 +210,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_materialization(timeout=3600) A waiting call until feature group version is materialized. @@ -466,7 +218,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the feature group version. @@ -475,7 +226,6 @@ Module Contents :rtype: str - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) @@ -490,7 +240,6 @@ Module Contents :rtype: DataFrame - .. py:method:: load_as_pandas_documents(doc_id_column, document_column, max_workers=10) Loads a feature group with documents data into a pandas dataframe. diff --git a/docs/_sources/autoapi/abacusai/feature_group_version_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_group_version_logs/index.rst.txt index 17e604930..a6fb733c6 100644 --- a/docs/_sources/autoapi/abacusai/feature_group_version_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_group_version_logs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_group_version_logs -=================================== +:py:mod:`abacusai.feature_group_version_logs` +============================================= .. py:module:: abacusai.feature_group_version_logs -Classes -------- - -.. autoapisummary:: - - abacusai.feature_group_version_logs.AbstractApiClass - abacusai.feature_group_version_logs.FeatureGroupVersionLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_group_version_logs.FeatureGroupVersionLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureGroupVersionLogs(client, logs=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs from feature group version. @@ -39,13 +29,11 @@ Module Contents :param logs: List of logs from feature group version. :type logs: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_importance/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_importance/index.rst.txt index e05c9ac97..12892841a 100644 --- a/docs/_sources/autoapi/abacusai/feature_importance/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_importance/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_importance -=========================== +:py:mod:`abacusai.feature_importance` +===================================== .. py:module:: abacusai.feature_importance -Classes -------- - -.. autoapisummary:: - - abacusai.feature_importance.AbstractApiClass - abacusai.feature_importance.FeatureImportance - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_importance.FeatureImportance - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureImportance(client, shapFeatureImportance=None, limeFeatureImportance=None, permutationFeatureImportance=None, nullFeatureImportance=None, lofoFeatureImportance=None, ebmFeatureImportance=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Feature importance for a specified model monitor @@ -49,13 +39,11 @@ Module Contents :param ebmFeatureImportance: A map of feature name to feature importance, determined by an Explainable Boosting Machine. :type ebmFeatureImportance: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_mapping/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_mapping/index.rst.txt index ad848a23a..b0192b797 100644 --- a/docs/_sources/autoapi/abacusai/feature_mapping/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_mapping/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_mapping -======================== +:py:mod:`abacusai.feature_mapping` +================================== .. py:module:: abacusai.feature_mapping -Classes -------- - -.. autoapisummary:: - - abacusai.feature_mapping.AbstractApiClass - abacusai.feature_mapping.FeatureMapping - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_mapping.FeatureMapping - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureMapping(client, featureMapping=None, featureName=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A description of the data use for a feature @@ -41,13 +31,11 @@ Module Contents :param featureName: The unique name of the feature. :type featureName: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_performance_analysis/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_performance_analysis/index.rst.txt index 6e752f655..bd3cbe220 100644 --- a/docs/_sources/autoapi/abacusai/feature_performance_analysis/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_performance_analysis/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_performance_analysis -===================================== +:py:mod:`abacusai.feature_performance_analysis` +=============================================== .. py:module:: abacusai.feature_performance_analysis -Classes -------- - -.. autoapisummary:: - - abacusai.feature_performance_analysis.AbstractApiClass - abacusai.feature_performance_analysis.FeaturePerformanceAnalysis - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_performance_analysis.FeaturePerformanceAnalysis - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeaturePerformanceAnalysis(client, features=None, featureMetrics=None, metricsKeys=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A feature performance analysis for Monitor @@ -43,13 +33,11 @@ Module Contents :param metricsKeys: A list of the keys for the metrics. :type metricsKeys: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/feature_record/index.rst.txt b/docs/_sources/autoapi/abacusai/feature_record/index.rst.txt index e403f99a5..141ce5184 100644 --- a/docs/_sources/autoapi/abacusai/feature_record/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/feature_record/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.feature_record -======================= +:py:mod:`abacusai.feature_record` +================================= .. py:module:: abacusai.feature_record -Classes -------- - -.. autoapisummary:: - - abacusai.feature_record.AbstractApiClass - abacusai.feature_record.FeatureRecord - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.feature_record.FeatureRecord - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FeatureRecord(client, data=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A feature record @@ -39,13 +29,11 @@ Module Contents :param data: the record's current data :type data: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/file_connector/index.rst.txt b/docs/_sources/autoapi/abacusai/file_connector/index.rst.txt index c0734bfbc..3126f2dd6 100644 --- a/docs/_sources/autoapi/abacusai/file_connector/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/file_connector/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.file_connector -======================= +:py:mod:`abacusai.file_connector` +================================= .. py:module:: abacusai.file_connector -Classes -------- - -.. autoapisummary:: - - abacusai.file_connector.AbstractApiClass - abacusai.file_connector.FileConnector - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.file_connector.FileConnector - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FileConnector(client, bucket=None, verified=None, writePermission=None, authExpiresAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Verification result for an external storage service @@ -45,13 +35,11 @@ Module Contents :param authExpiresAt: The time when the file connector's auth expires, if applicable :type authExpiresAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/file_connector_instructions/index.rst.txt b/docs/_sources/autoapi/abacusai/file_connector_instructions/index.rst.txt index 0fbf29b93..7e4936fc1 100644 --- a/docs/_sources/autoapi/abacusai/file_connector_instructions/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/file_connector_instructions/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.file_connector_instructions -==================================== +:py:mod:`abacusai.file_connector_instructions` +============================================== .. py:module:: abacusai.file_connector_instructions -Classes -------- - -.. autoapisummary:: - - abacusai.file_connector_instructions.AbstractApiClass - abacusai.file_connector_instructions.FileConnectorInstructions - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.file_connector_instructions.FileConnectorInstructions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FileConnectorInstructions(client, verified=None, writePermission=None, authOptions=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An object with a full description of the cloud storage bucket authentication options and bucket policy. Returns an error message if the parameters are invalid. @@ -43,13 +33,11 @@ Module Contents :param authOptions: A list of options for giving Abacus.AI access to this bucket :type authOptions: list[dict] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/file_connector_verification/index.rst.txt b/docs/_sources/autoapi/abacusai/file_connector_verification/index.rst.txt index 3af142d58..8e42603e1 100644 --- a/docs/_sources/autoapi/abacusai/file_connector_verification/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/file_connector_verification/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.file_connector_verification -==================================== +:py:mod:`abacusai.file_connector_verification` +============================================== .. py:module:: abacusai.file_connector_verification -Classes -------- - -.. autoapisummary:: - - abacusai.file_connector_verification.AbstractApiClass - abacusai.file_connector_verification.FileConnectorVerification - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.file_connector_verification.FileConnectorVerification - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FileConnectorVerification(client, verified=None, writePermission=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` To verify the file connector @@ -41,13 +31,11 @@ Module Contents :param writePermission: `true` if Abacus.AI has permission to write to this bucket :type writePermission: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/finetuned_pretrained_model/index.rst.txt b/docs/_sources/autoapi/abacusai/finetuned_pretrained_model/index.rst.txt index 542ef3271..0117aff0b 100644 --- a/docs/_sources/autoapi/abacusai/finetuned_pretrained_model/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/finetuned_pretrained_model/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.finetuned_pretrained_model -=================================== +:py:mod:`abacusai.finetuned_pretrained_model` +============================================= .. py:module:: abacusai.finetuned_pretrained_model -Classes -------- - -.. autoapisummary:: - - abacusai.finetuned_pretrained_model.AbstractApiClass - abacusai.finetuned_pretrained_model.FinetunedPretrainedModel - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.finetuned_pretrained_model.FinetunedPretrainedModel - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: FinetunedPretrainedModel(client, name=None, finetunedPretrainedModelId=None, finetunedPretrainedModelVersion=None, createdAt=None, updatedAt=None, config=None, baseModel=None, finetuningDatasetVersion=None, status=None, error=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A finetuned pretrained model @@ -57,13 +47,11 @@ Module Contents :param error: Relevant error if the status is FAILED. :type error: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/forecasting_analysis_graph_data/index.rst.txt b/docs/_sources/autoapi/abacusai/forecasting_analysis_graph_data/index.rst.txt index 1373ea872..95ae89418 100644 --- a/docs/_sources/autoapi/abacusai/forecasting_analysis_graph_data/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/forecasting_analysis_graph_data/index.rst.txt @@ -1,116 +1,26 @@ -abacusai.forecasting_analysis_graph_data -======================================== +:py:mod:`abacusai.forecasting_analysis_graph_data` +================================================== .. py:module:: abacusai.forecasting_analysis_graph_data -Classes -------- - -.. autoapisummary:: - - abacusai.forecasting_analysis_graph_data.EdaChartDescription - abacusai.forecasting_analysis_graph_data.ItemStatistics - abacusai.forecasting_analysis_graph_data.AbstractApiClass - abacusai.forecasting_analysis_graph_data.ForecastingAnalysisGraphData - - Module Contents --------------- -.. py:class:: EdaChartDescription(client, chartType=None, description=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Eda Chart Description. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param chartType: Name of chart. - :type chartType: str - :param description: Description of the eda chart. - :type description: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ItemStatistics(client, missingPercent=None, count=None, median=None, mean=None, p10=None, p90=None, stddev=None, min=None, max=None, lowerBound=None, upperBound=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - ItemStatistics representation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param missingPercent: percentage of missing values in data - :type missingPercent: float - :param count: count of data - :type count: int - :param median: median of the data - :type median: float - :param mean: mean value of the data - :type mean: float - :param p10: 10th percentile of the data - :type p10: float - :param p90: 90th_percentile of the data - :type p90: float - :param stddev: standard deviation of the data - :type stddev: float - :param min: min value in the data - :type min: int - :param max: max value in the data - :type max: int - :param lowerBound: lower bound threshold of the data - :type lowerBound: float - :param upperBound: upper bound threshold of the data - :type upperBound: float - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.forecasting_analysis_graph_data.ForecastingAnalysisGraphData - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ForecastingAnalysisGraphData(client, data=None, xAxis=None, yAxis=None, dataColumns=None, chartName=None, chartTypes=None, itemStatistics={}, chartDescriptions={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Forecasting Analysis Graph Data representation. @@ -133,13 +43,11 @@ Module Contents :param chartDescriptions: List of descriptions of what the chart contains :type chartDescriptions: EdaChartDescription - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/forecasting_monitor_item_analysis/index.rst.txt b/docs/_sources/autoapi/abacusai/forecasting_monitor_item_analysis/index.rst.txt index cd4f6079a..a3b0283d5 100644 --- a/docs/_sources/autoapi/abacusai/forecasting_monitor_item_analysis/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/forecasting_monitor_item_analysis/index.rst.txt @@ -1,79 +1,26 @@ -abacusai.forecasting_monitor_item_analysis -========================================== +:py:mod:`abacusai.forecasting_monitor_item_analysis` +==================================================== .. py:module:: abacusai.forecasting_monitor_item_analysis -Classes -------- - -.. autoapisummary:: - - abacusai.forecasting_monitor_item_analysis.ForecastingAnalysisGraphData - abacusai.forecasting_monitor_item_analysis.AbstractApiClass - abacusai.forecasting_monitor_item_analysis.ForecastingMonitorItemAnalysis - - Module Contents --------------- -.. py:class:: ForecastingAnalysisGraphData(client, data=None, xAxis=None, yAxis=None, dataColumns=None, chartName=None, chartTypes=None, itemStatistics={}, chartDescriptions={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Forecasting Analysis Graph Data representation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param data: List of graph data - :type data: list - :param xAxis: Feature that represents the x axis - :type xAxis: str - :param yAxis: Feature that represents the y axis - :type yAxis: str - :param dataColumns: Ordered name of the column for each rowwise data - :type dataColumns: list - :param chartName: Name of the chart represented by the data - :type chartName: str - :param chartTypes: Type of charts in that can exist in the current data. - :type chartTypes: list - :param itemStatistics: In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max - :type itemStatistics: ItemStatistics - :param chartDescriptions: List of descriptions of what the chart contains - :type chartDescriptions: EdaChartDescription - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.forecasting_monitor_item_analysis.ForecastingMonitorItemAnalysis - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ForecastingMonitorItemAnalysis(client, predictionItemAnalysis={}, trainingItemAnalysis={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Forecasting Monitor Item Analysis of the latest version of the data. @@ -84,13 +31,11 @@ Module Contents :param trainingItemAnalysis: Data showing average, p10, p90, median sales across time for training data :type trainingItemAnalysis: ForecastingAnalysisGraphData - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/forecasting_monitor_summary/index.rst.txt b/docs/_sources/autoapi/abacusai/forecasting_monitor_summary/index.rst.txt index 857415df1..d5852e1ea 100644 --- a/docs/_sources/autoapi/abacusai/forecasting_monitor_summary/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/forecasting_monitor_summary/index.rst.txt @@ -1,122 +1,26 @@ -abacusai.forecasting_monitor_summary -==================================== +:py:mod:`abacusai.forecasting_monitor_summary` +============================================== .. py:module:: abacusai.forecasting_monitor_summary -Classes -------- - -.. autoapisummary:: - - abacusai.forecasting_monitor_summary.FeatureDriftRecord - abacusai.forecasting_monitor_summary.ForecastingAnalysisGraphData - abacusai.forecasting_monitor_summary.AbstractApiClass - abacusai.forecasting_monitor_summary.ForecastingMonitorSummary - - Module Contents --------------- -.. py:class:: FeatureDriftRecord(client, name=None, distance=None, jsDistance=None, wsDistance=None, ksStatistic=None, psi=None, csi=None, chiSquare=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Value of each type of drift - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: Name of feature. - :type name: str - :param distance: Symmetric sum of KL divergences between the training distribution and the range of values in the specified window. - :type distance: float - :param jsDistance: JS divergence between the training distribution and the range of values in the specified window. - :type jsDistance: float - :param wsDistance: Wasserstein distance between the training distribution and the range of values in the specified window. - :type wsDistance: float - :param ksStatistic: Kolmogorov-Smirnov statistic computed between the training distribution and the range of values in the specified window. - :type ksStatistic: float - :param psi: Population stability index computed between the training distribution and the range of values in the specified window. - :type psi: float - :param csi: Characteristic Stability Index computed between the training distribution and the range of values in the specified window. - :type csi: float - :param chiSquare: Chi-square statistic computed between the training distribution and the range of values in the specified window. - :type chiSquare: float - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ForecastingAnalysisGraphData(client, data=None, xAxis=None, yAxis=None, dataColumns=None, chartName=None, chartTypes=None, itemStatistics={}, chartDescriptions={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Forecasting Analysis Graph Data representation. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param data: List of graph data - :type data: list - :param xAxis: Feature that represents the x axis - :type xAxis: str - :param yAxis: Feature that represents the y axis - :type yAxis: str - :param dataColumns: Ordered name of the column for each rowwise data - :type dataColumns: list - :param chartName: Name of the chart represented by the data - :type chartName: str - :param chartTypes: Type of charts in that can exist in the current data. - :type chartTypes: list - :param itemStatistics: In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max - :type itemStatistics: ItemStatistics - :param chartDescriptions: List of descriptions of what the chart contains - :type chartDescriptions: EdaChartDescription - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.forecasting_monitor_summary.ForecastingMonitorSummary - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ForecastingMonitorSummary(client, predictionTimestampCol=None, predictionTargetCol=None, trainingTimestampCol=None, trainingTargetCol=None, predictionItemId=None, trainingItemId=None, forecastFrequency=None, trainingTargetAcrossTime={}, predictionTargetAcrossTime={}, actualsHistogram={}, predictionsHistogram={}, trainHistoryData={}, predictHistoryData={}, targetDrift={}, historyDrift={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Forecasting Monitor Summary of the latest version of the data. @@ -153,13 +57,11 @@ Module Contents :param historyDrift: Data showing drift of the history for all drift types: distance (KL divergence), js_distance, ws_distance, ks_statistic, psi, csi, chi_square :type historyDrift: FeatureDriftRecord - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/function_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/function_logs/index.rst.txt index a99216187..33c0a0ba2 100644 --- a/docs/_sources/autoapi/abacusai/function_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/function_logs/index.rst.txt @@ -1,69 +1,26 @@ -abacusai.function_logs -====================== +:py:mod:`abacusai.function_logs` +================================ .. py:module:: abacusai.function_logs -Classes -------- - -.. autoapisummary:: - - abacusai.function_logs.AbstractApiClass - abacusai.function_logs.UserException - abacusai.function_logs.FunctionLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: _get_attribute_as_dict(attribute) - - -.. py:class:: UserException(client, type=None, value=None, traceback=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Exception information for errors in usercode. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: The type of exception - :type type: str - :param value: The value of the exception - :type value: str - :param traceback: The traceback of the exception - :type traceback: str - - - .. py:method:: __repr__() - - Return repr(self). - - +Classes +~~~~~~~ - .. py:method:: to_dict() +.. autoapisummary:: - Get a dict representation of the parameters in this class + abacusai.function_logs.FunctionLogs - :returns: The dict value representation of the class parameters - :rtype: dict .. py:class:: FunctionLogs(client, function=None, stats=None, stdout=None, stderr=None, algorithm=None, exception={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs from an invocation of a function. @@ -82,13 +39,11 @@ Module Contents :param exception: The exception stacktrace :type exception: UserException - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/generated_pit_feature_config_option/index.rst.txt b/docs/_sources/autoapi/abacusai/generated_pit_feature_config_option/index.rst.txt index b47b0c489..fe6996e7f 100644 --- a/docs/_sources/autoapi/abacusai/generated_pit_feature_config_option/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/generated_pit_feature_config_option/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.generated_pit_feature_config_option -============================================ +:py:mod:`abacusai.generated_pit_feature_config_option` +====================================================== .. py:module:: abacusai.generated_pit_feature_config_option -Classes -------- - -.. autoapisummary:: - - abacusai.generated_pit_feature_config_option.AbstractApiClass - abacusai.generated_pit_feature_config_option.GeneratedPitFeatureConfigOption - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.generated_pit_feature_config_option.GeneratedPitFeatureConfigOption - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: GeneratedPitFeatureConfigOption(client, name=None, displayName=None, default=None, description=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The options to display for possible generated PIT aggregation functions @@ -45,13 +35,11 @@ Module Contents :param description: The description of the aggregation type. :type description: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/global_context/index.rst.txt b/docs/_sources/autoapi/abacusai/global_context/index.rst.txt index ffb9847cf..3b5e41a13 100644 --- a/docs/_sources/autoapi/abacusai/global_context/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/global_context/index.rst.txt @@ -1,20 +1,15 @@ -abacusai.global_context -======================= +:py:mod:`abacusai.global_context` +================================= .. py:module:: abacusai.global_context -Attributes ----------- - -.. autoapisummary:: - - abacusai.global_context.lock - abacusai.global_context._context +Module Contents +--------------- Functions ---------- +~~~~~~~~~ .. autoapisummary:: @@ -22,14 +17,27 @@ Functions abacusai.global_context.set -Module Contents ---------------- + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + abacusai.global_context.lock + abacusai.global_context._context + .. py:data:: lock + + .. py:data:: _context + + .. py:function:: get(key) + .. py:function:: set(key, val) + diff --git a/docs/_sources/autoapi/abacusai/graph_dashboard/index.rst.txt b/docs/_sources/autoapi/abacusai/graph_dashboard/index.rst.txt index f9c97cc45..bb00f7e2d 100644 --- a/docs/_sources/autoapi/abacusai/graph_dashboard/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/graph_dashboard/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.graph_dashboard -======================== +:py:mod:`abacusai.graph_dashboard` +================================== .. py:module:: abacusai.graph_dashboard -Classes -------- - -.. autoapisummary:: - - abacusai.graph_dashboard.AbstractApiClass - abacusai.graph_dashboard.GraphDashboard - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.graph_dashboard.GraphDashboard - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: GraphDashboard(client, name=None, graphDashboardId=None, createdAt=None, projectId=None, pythonFunctionIds=None, plotReferenceIds=None, pythonFunctionNames=None, projectName=None, description=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Graph Dashboard @@ -55,13 +45,11 @@ Module Contents :param description: The description of the graph dashboard. :type description: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -70,7 +58,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -79,7 +66,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: describe() Describes a given graph dashboard. @@ -91,7 +77,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: delete() Deletes a graph dashboard @@ -100,7 +85,6 @@ Module Contents :type graph_dashboard_id: str - .. py:method:: update(name = None, python_function_ids = None) Updates a graph dashboard diff --git a/docs/_sources/autoapi/abacusai/holdout_analysis/index.rst.txt b/docs/_sources/autoapi/abacusai/holdout_analysis/index.rst.txt index 49c7be711..cbf02400c 100644 --- a/docs/_sources/autoapi/abacusai/holdout_analysis/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/holdout_analysis/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.holdout_analysis -========================= +:py:mod:`abacusai.holdout_analysis` +=================================== .. py:module:: abacusai.holdout_analysis -Classes -------- - -.. autoapisummary:: - - abacusai.holdout_analysis.AbstractApiClass - abacusai.holdout_analysis.HoldoutAnalysis - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.holdout_analysis.HoldoutAnalysis - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: HoldoutAnalysis(client, holdoutAnalysisId=None, name=None, featureGroupIds=None, modelId=None, modelName=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A holdout analysis object. @@ -47,13 +37,11 @@ Module Contents :param modelName: The model name associated with the holdout analysis. :type modelName: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -62,7 +50,6 @@ Module Contents :rtype: dict - .. py:method:: rerun(model_version = None, algorithm = None) Rerun a holdout analysis. A different model version and algorithm can be specified which should be under the same model. @@ -76,7 +63,6 @@ Module Contents :rtype: HoldoutAnalysisVersion - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -85,7 +71,6 @@ Module Contents :rtype: HoldoutAnalysis - .. py:method:: describe() Get a holdout analysis. @@ -97,7 +82,6 @@ Module Contents :rtype: HoldoutAnalysis - .. py:method:: list_versions() List holdout analysis versions for a holdout analysis. diff --git a/docs/_sources/autoapi/abacusai/holdout_analysis_version/index.rst.txt b/docs/_sources/autoapi/abacusai/holdout_analysis_version/index.rst.txt index fd4db5290..f9f4603fa 100644 --- a/docs/_sources/autoapi/abacusai/holdout_analysis_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/holdout_analysis_version/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.holdout_analysis_version -================================= +:py:mod:`abacusai.holdout_analysis_version` +=========================================== .. py:module:: abacusai.holdout_analysis_version -Classes -------- - -.. autoapisummary:: - - abacusai.holdout_analysis_version.AbstractApiClass - abacusai.holdout_analysis_version.HoldoutAnalysisVersion - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.holdout_analysis_version.HoldoutAnalysisVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: HoldoutAnalysisVersion(client, holdoutAnalysisVersion=None, holdoutAnalysisId=None, createdAt=None, status=None, error=None, modelId=None, modelVersion=None, algorithm=None, algoName=None, metrics=None, metricInfos=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A holdout analysis version object. @@ -59,13 +49,11 @@ Module Contents :param metricInfos: The metric infos of the holdout analysis version. :type metricInfos: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -74,7 +62,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -83,7 +70,6 @@ Module Contents :rtype: HoldoutAnalysisVersion - .. py:method:: describe(get_metrics = False) Get a holdout analysis version. @@ -95,7 +81,6 @@ Module Contents :rtype: HoldoutAnalysisVersion - .. py:method:: wait_for_results(timeout=3600) A waiting call until holdout analysis for the version is complete @@ -104,7 +89,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the holdout analysis version. diff --git a/docs/_sources/autoapi/abacusai/hosted_model_token/index.rst.txt b/docs/_sources/autoapi/abacusai/hosted_model_token/index.rst.txt index c3137a4a8..d56886d81 100644 --- a/docs/_sources/autoapi/abacusai/hosted_model_token/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/hosted_model_token/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.hosted_model_token -=========================== +:py:mod:`abacusai.hosted_model_token` +===================================== .. py:module:: abacusai.hosted_model_token -Classes -------- - -.. autoapisummary:: - - abacusai.hosted_model_token.AbstractApiClass - abacusai.hosted_model_token.HostedModelToken - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.hosted_model_token.HostedModelToken - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: HostedModelToken(client, createdAt=None, tag=None, trailingAuthToken=None, hostedModelTokenId=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A hosted model authentication token that is used to authenticate requests to an abacus hosted model @@ -45,13 +35,11 @@ Module Contents :param hostedModelTokenId: The unique identifier attached to this authenticaion token :type hostedModelTokenId: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/index.rst.txt b/docs/_sources/autoapi/abacusai/index.rst.txt index 094558749..b5868957b 100644 --- a/docs/_sources/autoapi/abacusai/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/index.rst.txt @@ -1,249 +1,234 @@ -abacusai -======== +:py:mod:`abacusai` +================== .. py:module:: abacusai Subpackages ----------- - .. toctree:: - :maxdepth: 1 + :titlesonly: + :maxdepth: 3 - /autoapi/abacusai/api_class/index + api_class/index.rst Submodules ---------- - .. toctree:: + :titlesonly: :maxdepth: 1 - /autoapi/abacusai/abacus_api/index - /autoapi/abacusai/agent/index - /autoapi/abacusai/agent_data_document_info/index - /autoapi/abacusai/agent_data_execution_result/index - /autoapi/abacusai/agent_version/index - /autoapi/abacusai/ai_building_task/index - /autoapi/abacusai/algorithm/index - /autoapi/abacusai/annotation/index - /autoapi/abacusai/annotation_config/index - /autoapi/abacusai/annotation_document/index - /autoapi/abacusai/annotation_entry/index - /autoapi/abacusai/annotations_status/index - /autoapi/abacusai/api_client_utils/index - /autoapi/abacusai/api_endpoint/index - /autoapi/abacusai/api_key/index - /autoapi/abacusai/app_user_group/index - /autoapi/abacusai/application_connector/index - /autoapi/abacusai/batch_prediction/index - /autoapi/abacusai/batch_prediction_version/index - /autoapi/abacusai/batch_prediction_version_logs/index - /autoapi/abacusai/categorical_range_violation/index - /autoapi/abacusai/chat_message/index - /autoapi/abacusai/chat_session/index - /autoapi/abacusai/client/index - /autoapi/abacusai/code_source/index - /autoapi/abacusai/concatenation_config/index - /autoapi/abacusai/cpu_gpu_memory_specs/index - /autoapi/abacusai/cryptography/index - /autoapi/abacusai/custom_loss_function/index - /autoapi/abacusai/custom_metric/index - /autoapi/abacusai/custom_metric_version/index - /autoapi/abacusai/custom_train_function_info/index - /autoapi/abacusai/data_consistency_duplication/index - /autoapi/abacusai/data_metrics/index - /autoapi/abacusai/data_prep_logs/index - /autoapi/abacusai/data_quality_results/index - /autoapi/abacusai/data_upload_result/index - /autoapi/abacusai/database_column_feature_mapping/index - /autoapi/abacusai/database_connector/index - /autoapi/abacusai/database_connector_column/index - /autoapi/abacusai/database_connector_schema/index - /autoapi/abacusai/dataset/index - /autoapi/abacusai/dataset_column/index - /autoapi/abacusai/dataset_version/index - /autoapi/abacusai/dataset_version_logs/index - /autoapi/abacusai/deployment/index - /autoapi/abacusai/deployment_auth_token/index - /autoapi/abacusai/deployment_conversation/index - /autoapi/abacusai/deployment_conversation_event/index - /autoapi/abacusai/deployment_conversation_export/index - /autoapi/abacusai/document_data/index - /autoapi/abacusai/document_retriever/index - /autoapi/abacusai/document_retriever_config/index - /autoapi/abacusai/document_retriever_lookup_result/index - /autoapi/abacusai/document_retriever_version/index - /autoapi/abacusai/drift_distribution/index - /autoapi/abacusai/drift_distributions/index - /autoapi/abacusai/eda/index - /autoapi/abacusai/eda_chart_description/index - /autoapi/abacusai/eda_collinearity/index - /autoapi/abacusai/eda_data_consistency/index - /autoapi/abacusai/eda_feature_association/index - /autoapi/abacusai/eda_feature_collinearity/index - /autoapi/abacusai/eda_forecasting_analysis/index - /autoapi/abacusai/eda_version/index - /autoapi/abacusai/embedding_feature_drift_distribution/index - /autoapi/abacusai/execute_feature_group_operation/index - /autoapi/abacusai/external_application/index - /autoapi/abacusai/external_invite/index - /autoapi/abacusai/extracted_fields/index - /autoapi/abacusai/feature/index - /autoapi/abacusai/feature_distribution/index - /autoapi/abacusai/feature_drift_record/index - /autoapi/abacusai/feature_drift_summary/index - /autoapi/abacusai/feature_group/index - /autoapi/abacusai/feature_group_document/index - /autoapi/abacusai/feature_group_export/index - /autoapi/abacusai/feature_group_export_config/index - /autoapi/abacusai/feature_group_export_download_url/index - /autoapi/abacusai/feature_group_lineage/index - /autoapi/abacusai/feature_group_refresh_export_config/index - /autoapi/abacusai/feature_group_row/index - /autoapi/abacusai/feature_group_row_process/index - /autoapi/abacusai/feature_group_row_process_logs/index - /autoapi/abacusai/feature_group_row_process_summary/index - /autoapi/abacusai/feature_group_template/index - /autoapi/abacusai/feature_group_template_variable_options/index - /autoapi/abacusai/feature_group_version/index - /autoapi/abacusai/feature_group_version_logs/index - /autoapi/abacusai/feature_importance/index - /autoapi/abacusai/feature_mapping/index - /autoapi/abacusai/feature_performance_analysis/index - /autoapi/abacusai/feature_record/index - /autoapi/abacusai/file_connector/index - /autoapi/abacusai/file_connector_instructions/index - /autoapi/abacusai/file_connector_verification/index - /autoapi/abacusai/finetuned_pretrained_model/index - /autoapi/abacusai/forecasting_analysis_graph_data/index - /autoapi/abacusai/forecasting_monitor_item_analysis/index - /autoapi/abacusai/forecasting_monitor_summary/index - /autoapi/abacusai/function_logs/index - /autoapi/abacusai/generated_pit_feature_config_option/index - /autoapi/abacusai/global_context/index - /autoapi/abacusai/graph_dashboard/index - /autoapi/abacusai/holdout_analysis/index - /autoapi/abacusai/holdout_analysis_version/index - /autoapi/abacusai/hosted_model_token/index - /autoapi/abacusai/indexing_config/index - /autoapi/abacusai/inferred_database_column_to_feature_mappings/index - /autoapi/abacusai/inferred_feature_mappings/index - /autoapi/abacusai/item_statistics/index - /autoapi/abacusai/llm_app/index - /autoapi/abacusai/llm_code_block/index - /autoapi/abacusai/llm_execution_preview/index - /autoapi/abacusai/llm_execution_result/index - /autoapi/abacusai/llm_generated_code/index - /autoapi/abacusai/llm_input/index - /autoapi/abacusai/llm_parameters/index - /autoapi/abacusai/llm_response/index - /autoapi/abacusai/memory_options/index - /autoapi/abacusai/messaging_connector_response/index - /autoapi/abacusai/model/index - /autoapi/abacusai/model_artifacts_export/index - /autoapi/abacusai/model_blueprint_export/index - /autoapi/abacusai/model_blueprint_stage/index - /autoapi/abacusai/model_location/index - /autoapi/abacusai/model_metrics/index - /autoapi/abacusai/model_monitor/index - /autoapi/abacusai/model_monitor_org_summary/index - /autoapi/abacusai/model_monitor_summary/index - /autoapi/abacusai/model_monitor_summary_from_org/index - /autoapi/abacusai/model_monitor_version/index - /autoapi/abacusai/model_monitor_version_metric_data/index - /autoapi/abacusai/model_training_type_for_deployment/index - /autoapi/abacusai/model_upload/index - /autoapi/abacusai/model_version/index - /autoapi/abacusai/model_version_feature_group_schema/index - /autoapi/abacusai/modification_lock_info/index - /autoapi/abacusai/module/index - /autoapi/abacusai/monitor_alert/index - /autoapi/abacusai/monitor_alert_version/index - /autoapi/abacusai/monitor_drift_and_distributions/index - /autoapi/abacusai/natural_language_explanation/index - /autoapi/abacusai/nested_feature/index - /autoapi/abacusai/nested_feature_schema/index - /autoapi/abacusai/null_violation/index - /autoapi/abacusai/organization_external_application_settings/index - /autoapi/abacusai/organization_group/index - /autoapi/abacusai/organization_search_result/index - /autoapi/abacusai/organization_secret/index - /autoapi/abacusai/page_data/index - /autoapi/abacusai/pipeline/index - /autoapi/abacusai/pipeline_reference/index - /autoapi/abacusai/pipeline_step/index - /autoapi/abacusai/pipeline_step_version/index - /autoapi/abacusai/pipeline_step_version_logs/index - /autoapi/abacusai/pipeline_step_version_reference/index - /autoapi/abacusai/pipeline_version/index - /autoapi/abacusai/pipeline_version_logs/index - /autoapi/abacusai/point_in_time_feature/index - /autoapi/abacusai/point_in_time_feature_info/index - /autoapi/abacusai/point_in_time_group/index - /autoapi/abacusai/point_in_time_group_feature/index - /autoapi/abacusai/prediction_client/index - /autoapi/abacusai/prediction_dataset/index - /autoapi/abacusai/prediction_feature_group/index - /autoapi/abacusai/prediction_input/index - /autoapi/abacusai/prediction_operator/index - /autoapi/abacusai/prediction_operator_version/index - /autoapi/abacusai/problem_type/index - /autoapi/abacusai/project/index - /autoapi/abacusai/project_config/index - /autoapi/abacusai/project_feature_group/index - /autoapi/abacusai/project_feature_group_schema/index - /autoapi/abacusai/project_feature_group_schema_version/index - /autoapi/abacusai/project_validation/index - /autoapi/abacusai/python_function/index - /autoapi/abacusai/python_function_validator/index - /autoapi/abacusai/python_plot_function/index - /autoapi/abacusai/range_violation/index - /autoapi/abacusai/realtime_monitor/index - /autoapi/abacusai/refresh_pipeline_run/index - /autoapi/abacusai/refresh_policy/index - /autoapi/abacusai/refresh_schedule/index - /autoapi/abacusai/resolved_feature_group_template/index - /autoapi/abacusai/return_class/index - /autoapi/abacusai/schema/index - /autoapi/abacusai/streaming_auth_token/index - /autoapi/abacusai/streaming_client/index - /autoapi/abacusai/streaming_connector/index - /autoapi/abacusai/streaming_row_count/index - /autoapi/abacusai/streaming_sample_code/index - /autoapi/abacusai/test_point_predictions/index - /autoapi/abacusai/training_config_options/index - /autoapi/abacusai/upload/index - /autoapi/abacusai/upload_part/index - /autoapi/abacusai/use_case/index - /autoapi/abacusai/use_case_requirements/index - /autoapi/abacusai/user/index - /autoapi/abacusai/user_exception/index - /autoapi/abacusai/web_search_response/index - /autoapi/abacusai/web_search_result/index - /autoapi/abacusai/webhook/index - - -Attributes ----------- - -.. autoapisummary:: - - abacusai.DocumentRetrieverConfig - abacusai._request_context - abacusai.__version__ - - -Exceptions ----------- - -.. autoapisummary:: + abacus_api/index.rst + agent/index.rst + agent_data_document_info/index.rst + agent_data_execution_result/index.rst + agent_version/index.rst + ai_building_task/index.rst + algorithm/index.rst + annotation/index.rst + annotation_config/index.rst + annotation_document/index.rst + annotation_entry/index.rst + annotations_status/index.rst + api_client_utils/index.rst + api_endpoint/index.rst + api_key/index.rst + app_user_group/index.rst + application_connector/index.rst + batch_prediction/index.rst + batch_prediction_version/index.rst + batch_prediction_version_logs/index.rst + categorical_range_violation/index.rst + chat_message/index.rst + chat_session/index.rst + client/index.rst + code_source/index.rst + concatenation_config/index.rst + cpu_gpu_memory_specs/index.rst + cryptography/index.rst + custom_loss_function/index.rst + custom_metric/index.rst + custom_metric_version/index.rst + custom_train_function_info/index.rst + data_consistency_duplication/index.rst + data_metrics/index.rst + data_prep_logs/index.rst + data_quality_results/index.rst + data_upload_result/index.rst + database_column_feature_mapping/index.rst + database_connector/index.rst + database_connector_column/index.rst + database_connector_schema/index.rst + dataset/index.rst + dataset_column/index.rst + dataset_version/index.rst + dataset_version_logs/index.rst + deployment/index.rst + deployment_auth_token/index.rst + deployment_conversation/index.rst + deployment_conversation_event/index.rst + deployment_conversation_export/index.rst + document_data/index.rst + document_retriever/index.rst + document_retriever_config/index.rst + document_retriever_lookup_result/index.rst + document_retriever_version/index.rst + drift_distribution/index.rst + drift_distributions/index.rst + eda/index.rst + eda_chart_description/index.rst + eda_collinearity/index.rst + eda_data_consistency/index.rst + eda_feature_association/index.rst + eda_feature_collinearity/index.rst + eda_forecasting_analysis/index.rst + eda_version/index.rst + embedding_feature_drift_distribution/index.rst + execute_feature_group_operation/index.rst + external_application/index.rst + external_invite/index.rst + extracted_fields/index.rst + feature/index.rst + feature_distribution/index.rst + feature_drift_record/index.rst + feature_drift_summary/index.rst + feature_group/index.rst + feature_group_document/index.rst + feature_group_export/index.rst + feature_group_export_config/index.rst + feature_group_export_download_url/index.rst + feature_group_lineage/index.rst + feature_group_refresh_export_config/index.rst + feature_group_row/index.rst + feature_group_row_process/index.rst + feature_group_row_process_logs/index.rst + feature_group_row_process_summary/index.rst + feature_group_template/index.rst + feature_group_template_variable_options/index.rst + feature_group_version/index.rst + feature_group_version_logs/index.rst + feature_importance/index.rst + feature_mapping/index.rst + feature_performance_analysis/index.rst + feature_record/index.rst + file_connector/index.rst + file_connector_instructions/index.rst + file_connector_verification/index.rst + finetuned_pretrained_model/index.rst + forecasting_analysis_graph_data/index.rst + forecasting_monitor_item_analysis/index.rst + forecasting_monitor_summary/index.rst + function_logs/index.rst + generated_pit_feature_config_option/index.rst + global_context/index.rst + graph_dashboard/index.rst + holdout_analysis/index.rst + holdout_analysis_version/index.rst + hosted_model_token/index.rst + indexing_config/index.rst + inferred_database_column_to_feature_mappings/index.rst + inferred_feature_mappings/index.rst + item_statistics/index.rst + llm_app/index.rst + llm_code_block/index.rst + llm_execution_preview/index.rst + llm_execution_result/index.rst + llm_generated_code/index.rst + llm_input/index.rst + llm_parameters/index.rst + llm_response/index.rst + memory_options/index.rst + messaging_connector_response/index.rst + model/index.rst + model_artifacts_export/index.rst + model_blueprint_export/index.rst + model_blueprint_stage/index.rst + model_location/index.rst + model_metrics/index.rst + model_monitor/index.rst + model_monitor_org_summary/index.rst + model_monitor_summary/index.rst + model_monitor_summary_from_org/index.rst + model_monitor_version/index.rst + model_monitor_version_metric_data/index.rst + model_training_type_for_deployment/index.rst + model_upload/index.rst + model_version/index.rst + model_version_feature_group_schema/index.rst + modification_lock_info/index.rst + module/index.rst + monitor_alert/index.rst + monitor_alert_version/index.rst + monitor_drift_and_distributions/index.rst + natural_language_explanation/index.rst + nested_feature/index.rst + nested_feature_schema/index.rst + null_violation/index.rst + organization_external_application_settings/index.rst + organization_group/index.rst + organization_search_result/index.rst + organization_secret/index.rst + page_data/index.rst + pipeline/index.rst + pipeline_reference/index.rst + pipeline_step/index.rst + pipeline_step_version/index.rst + pipeline_step_version_logs/index.rst + pipeline_step_version_reference/index.rst + pipeline_version/index.rst + pipeline_version_logs/index.rst + point_in_time_feature/index.rst + point_in_time_feature_info/index.rst + point_in_time_group/index.rst + point_in_time_group_feature/index.rst + prediction_client/index.rst + prediction_dataset/index.rst + prediction_feature_group/index.rst + prediction_input/index.rst + prediction_operator/index.rst + prediction_operator_version/index.rst + problem_type/index.rst + project/index.rst + project_config/index.rst + project_feature_group/index.rst + project_feature_group_schema/index.rst + project_feature_group_schema_version/index.rst + project_validation/index.rst + python_function/index.rst + python_function_validator/index.rst + python_plot_function/index.rst + range_violation/index.rst + realtime_monitor/index.rst + refresh_pipeline_run/index.rst + refresh_policy/index.rst + refresh_schedule/index.rst + resolved_feature_group_template/index.rst + return_class/index.rst + schema/index.rst + streaming_auth_token/index.rst + streaming_client/index.rst + streaming_connector/index.rst + streaming_row_count/index.rst + streaming_sample_code/index.rst + test_point_predictions/index.rst + training_config_options/index.rst + upload/index.rst + upload_part/index.rst + use_case/index.rst + use_case_requirements/index.rst + user/index.rst + user_exception/index.rst + web_search_response/index.rst + web_search_result/index.rst + webhook/index.rst - abacusai.ApiException +Package Contents +---------------- Classes -------- +~~~~~~~ .. autoapisummary:: @@ -269,9 +254,13 @@ Classes abacusai.ChatLLMBatchPredictionArgs abacusai.TrainablePlugAndPlayBatchPredictionArgs abacusai._BatchPredictionArgsFactory + abacusai.Blob abacusai.BlobInput - abacusai.OcrMode abacusai.DatasetConfig + abacusai.StreamingConnectorDatasetConfig + abacusai.KafkaDatasetConfig + abacusai._StreamingConnectorDatasetConfigFactory + abacusai.OcrMode abacusai.ParsingConfig abacusai.DocumentProcessingConfig abacusai.DatasetDocumentProcessingConfig @@ -312,6 +301,8 @@ Classes abacusai.ExplainerType abacusai.SamplingMethodType abacusai.MergeMode + abacusai.OperatorType + abacusai.MarkdownOperatorInputType abacusai.FillLogic abacusai.BatchSize abacusai.HolidayCalendars @@ -354,6 +345,8 @@ Classes abacusai.DataType abacusai.AgentInterface abacusai.ProjectConfigType + abacusai.CPUSize + abacusai.MemorySize abacusai.SamplingConfig abacusai.NSamplingConfig abacusai.PercentSamplingConfig @@ -362,6 +355,12 @@ Classes abacusai.LastNMergeConfig abacusai.TimeWindowMergeConfig abacusai._MergeConfigFactory + abacusai.OperatorConfig + abacusai.UnpivotConfig + abacusai.MarkdownConfig + abacusai.CrawlerTransformConfig + abacusai.ExtractDocumentDataConfig + abacusai._OperatorConfigFactory abacusai.TrainingConfig abacusai.PersonalizationTrainingConfig abacusai.RegressionTrainingConfig @@ -426,33 +425,43 @@ Classes abacusai.StreamingClient + Functions ---------- +~~~~~~~~~ .. autoapisummary:: abacusai.get_clean_function_source_code -Package Contents ----------------- + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + abacusai.DocumentRetrieverConfig + abacusai._request_context + abacusai.__version__ + .. py:class:: ApiClass - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:method:: __post_init__() @@ -461,13 +470,11 @@ Package Contents :classmethod: - .. py:method:: __str__() Return str(self). - .. py:method:: _repr_html_() @@ -493,7 +500,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(input_dict) :classmethod: @@ -501,10 +507,11 @@ Package Contents .. py:function:: get_clean_function_source_code(func) + .. py:class:: FieldDescriptor - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Configs for vector store indexing. @@ -517,43 +524,48 @@ Package Contents :param type: The type of this field. If not provided, the default type is STRING. :type type: FieldDescriptorType - .. py:attribute:: field - :type: str + :type: str + .. py:attribute:: description - :type: str + :type: str + .. py:attribute:: example_extraction - :type: Union[str, int, bool, float, list, dict] + :type: Union[str, int, bool, float, list, dict] + .. py:attribute:: type - :type: abacusai.api_class.enums.FieldDescriptorType + :type: abacusai.api_class.enums.FieldDescriptorType + + .. py:class:: WorkflowNodeInputSchema - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A react-jsonschema-form conformant schema for workflow node input. - :param json_schema: The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, File Upload. Not supported - Nested elements, arrays and other complex types. + :param json_schema: The json schema for the input conformant to react-jsonschema-form specification. Must define keys like "title", "type" and "properties". Supported elements - Checkbox, Radio Button, Dropdown, Textarea, Number, Date, file upload. Not supported - Nested elements, arrays and other complex types. :type json_schema: dict :param ui_schema: The ui schema for the input conformant to react-jsonschema-form specification. :type ui_schema: dict - .. py:attribute:: json_schema - :type: dict + :type: dict + .. py:attribute:: ui_schema - :type: dict + :type: dict + .. py:method:: to_dict() @@ -562,7 +574,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(schema) :classmethod: @@ -570,18 +581,18 @@ Package Contents .. py:class:: WorkflowNodeOutputSchema - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A react-jsonschema-form schema for a workflow node output. :param json_schema: The json schema for the output conformant to react-jsonschema-form specification. :type json_schema: dict - .. py:attribute:: json_schema - :type: dict + :type: dict + .. py:method:: to_dict() @@ -590,7 +601,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(schema) :classmethod: @@ -598,8 +608,8 @@ Package Contents .. py:class:: WorkflowNodeInputMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A mapping of input to a workflow node. @@ -615,22 +625,25 @@ Package Contents :param is_required: Whether the input is required. Defaults to True :type is_required: bool - .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: variable_type - :type: abacusai.api_class.enums.WorkflowNodeInputType + :type: abacusai.api_class.enums.WorkflowNodeInputType + .. py:attribute:: variable_source - :type: str + :type: str + .. py:attribute:: is_required - :type: bool + :type: bool + .. py:method:: to_dict() @@ -639,7 +652,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(mapping) :classmethod: @@ -647,8 +659,8 @@ Package Contents .. py:class:: WorkflowNodeOutputMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A mapping of output to a workflow node. @@ -657,14 +669,15 @@ Package Contents :param variable_type: The type of the output. :type variable_type: WorkflowNodeOutputType - .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: variable_type - :type: abacusai.api_class.enums.WorkflowNodeOutputType + :type: abacusai.api_class.enums.WorkflowNodeOutputType + .. py:method:: to_dict() @@ -673,7 +686,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(mapping) :classmethod: @@ -681,8 +693,8 @@ Package Contents .. py:class:: WorkflowGraphNode(name, input_mappings, output_mappings, function = None, function_name = None, source_code = None, input_schema = None, output_schema = None, package_requirements = None) - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A node in an Agent workflow graph. @@ -701,7 +713,6 @@ Package Contents :param package_requirements: List of package requirements for the node. :type package_requirements: list - .. py:method:: to_dict() Standardizes converting an ApiClass to dictionary. @@ -709,7 +720,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(node) :classmethod: @@ -717,8 +727,8 @@ Package Contents .. py:class:: WorkflowGraphEdge - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An edge in an Agent workflow graph. @@ -729,26 +739,29 @@ Package Contents :param details: Additional details about the edge. :type details: dict - .. py:attribute:: source - :type: str + :type: str + .. py:attribute:: target - :type: str + :type: str + .. py:attribute:: details - :type: dict + :type: dict + .. py:method:: to_nx_edge() + .. py:class:: WorkflowGraph - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. @@ -757,14 +770,15 @@ Package Contents :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. :type edges: List[WorkflowGraphEdge] - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] + :type: List[WorkflowGraphNode] + .. py:attribute:: edges - :type: List[WorkflowGraphEdge] + :type: List[WorkflowGraphEdge] + .. py:method:: to_dict() @@ -773,7 +787,6 @@ Package Contents This also validates the fields ( type, value, etc ) received in the dictionary. - .. py:method:: from_dict(graph) :classmethod: @@ -781,8 +794,8 @@ Package Contents .. py:class:: HotkeyPrompt - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for a Data Science Co-Pilot Hotkey @@ -791,44 +804,46 @@ Package Contents :param title: A short, descriptive title for the prompt. If not provided, one will be automatically generated. :type title: str - .. py:attribute:: prompt - :type: str + :type: str + .. py:attribute:: title - :type: str + :type: str + .. py:attribute:: disable_problem_type_context - :type: bool + :type: bool + .. py:attribute:: ignore_history - :type: bool + :type: bool + + .. py:class:: _ApiClassFactory - Bases: :py:obj:`abc.ABC` + Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class - :value: None - + .. py:attribute:: config_class_key - :value: None - + .. py:attribute:: config_class_map + .. py:method:: from_dict(config) :classmethod: @@ -837,23 +852,25 @@ Package Contents .. py:class:: BatchPredictionArgs - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for Batch Prediction args specific to problem type. - .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:method:: _get_builder() :classmethod: @@ -862,8 +879,8 @@ Package Contents .. py:class:: ForecastingBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the FORECASTING problem type @@ -884,64 +901,73 @@ Package Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: predictions_start_date - :type: str + :type: str + .. py:attribute:: use_prediction_offset - :type: bool + :type: bool + .. py:attribute:: start_date_offset - :type: int + :type: int + .. py:attribute:: forecasting_horizon - :type: int + :type: int + .. py:attribute:: item_attributes_to_include_in_the_result - :type: list + :type: list + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NamedEntityExtractionBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the NAMED_ENTITY_EXTRACTION problem type :param for_eval: If True, the test fold which was created during training and used for metrics calculation will be used as input data. These predictions are hence, used for model evaluation. :type for_eval: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: PersonalizationBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PERSONALIZATION problem type @@ -954,30 +980,34 @@ Package Contents :param score_field: If specified, relative item scores will be returned using a field with this name :type score_field: str - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: number_of_items - :type: int + :type: int + .. py:attribute:: item_attributes_to_include_in_the_result - :type: list + :type: list + .. py:attribute:: score_field - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: PredictiveModelingBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PREDICTIVE_MODELING problem type @@ -1006,62 +1036,74 @@ Package Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: abacusai.api_class.enums.ExplainerType + :type: abacusai.api_class.enums.ExplainerType + .. py:attribute:: number_of_samples_to_use_for_explainer - :type: int + :type: int + .. py:attribute:: include_multi_class_explanations - :type: bool + :type: bool + .. py:attribute:: features_considered_constant_for_explanations - :type: str + :type: str + .. py:attribute:: importance_of_records_in_nested_columns - :type: str + :type: str + .. py:attribute:: explanation_filter_lower_bound - :type: float + :type: float + .. py:attribute:: explanation_filter_upper_bound - :type: float + :type: float + .. py:attribute:: explanation_filter_label - :type: str + :type: str + .. py:attribute:: output_columns - :type: list + :type: list + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: PretrainedModelsBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the PRETRAINED_MODELS problem type @@ -1072,26 +1114,29 @@ Package Contents :param channel_id_to_label_map: JSON string for the map from channel ids to their labels. :type channel_id_to_label_map: str - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: files_output_location_prefix - :type: str + :type: str + .. py:attribute:: channel_id_to_label_map - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: SentenceBoundaryDetectionBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the SENTENCE_BOUNDARY_DETECTION problem type @@ -1100,22 +1145,24 @@ Package Contents :param explode_output: Explode data so there is one sentence per row. :type explode_output: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: explode_output - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ThemeAnalysisBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the THEME_ANALYSIS problem type @@ -1128,48 +1175,53 @@ Package Contents :param analysis_days: How many days to analyze. :type analysis_days: int - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: analysis_frequency - :type: str + :type: str + .. py:attribute:: start_date - :type: str + :type: str + .. py:attribute:: analysis_days - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: ChatLLMBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the ChatLLM problem type :param for_eval: If True, the test fold which was created during training and used for metrics calculation will be used as input data. These predictions are hence, used for model evaluation. :type for_eval: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TrainablePlugAndPlayBatchPredictionArgs - Bases: :py:obj:`BatchPredictionArgs` + Bases: :py:obj:`BatchPredictionArgs` Batch Prediction Config for the TrainablePlugAndPlay problem type @@ -1178,44 +1230,48 @@ Package Contents :param create_monitor: Controls whether to automatically create a monitor to calculate the drift each time the batch prediction is run. Defaults to true if not specified. :type create_monitor: bool - .. py:attribute:: for_eval - :type: bool + :type: bool + .. py:attribute:: create_monitor - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _BatchPredictionArgsFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + -.. py:class:: BlobInput - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` +.. py:class:: Blob(contents, mime_type = None, filename = None, size = None) - Binary large object input data. + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + + Binary large object data. :param filename: The original filename of the blob. :type filename: str @@ -1226,92 +1282,170 @@ Package Contents :param size: The size of the blob in bytes. :type size: int - .. py:attribute:: filename - :type: str + :type: str + .. py:attribute:: contents - :type: bytes + :type: bytes + .. py:attribute:: mime_type - :type: str + :type: str + .. py:attribute:: size - :type: int + :type: int + .. py:method:: from_local_file(file_path) :classmethod: - .. py:method:: from_contents(contents, filename = None, mime_type = None) :classmethod: +.. py:class:: BlobInput(filename = None, contents = None, mime_type = None, size = None) + + + Bases: :py:obj:`Blob` + + Binary large object data. + An alias for Blob, used to indicate that this is an input object. + + +.. py:class:: DatasetConfig + + + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + + An abstract class for dataset configs + + :param is_documentset: Whether the dataset is a document set + :type is_documentset: bool + + .. py:attribute:: is_documentset + :type: bool + + + + +.. py:class:: StreamingConnectorDatasetConfig + + + Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` + + An abstract class for dataset configs specific to streaming connectors. + + :param streaming_connector_type: The type of streaming connector + :type streaming_connector_type: StreamingConnectorType + + .. py:attribute:: streaming_connector_type + :type: abacusai.api_class.enums.StreamingConnectorType + + + + .. py:method:: _get_builder() + :classmethod: + + + +.. py:class:: KafkaDatasetConfig + + + Bases: :py:obj:`StreamingConnectorDatasetConfig` + + Dataset config for Kafka Streaming Connector + + :param topic: The kafka topic to consume + :type topic: str + + .. py:attribute:: topic + :type: str + + + + .. py:method:: __post_init__() + + + +.. py:class:: _StreamingConnectorDatasetConfigFactory + + + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + + Helper class that provides a standard way to create an ABC using + inheritance. + + .. py:attribute:: config_abstract_class + + + + .. py:attribute:: config_class_key + :value: 'streaming_connector_type' + + + + .. py:attribute:: config_class_map + + + + .. py:class:: OcrMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEFAULT :value: 'DEFAULT' - + .. py:attribute:: LAYOUT :value: 'LAYOUT' - + .. py:attribute:: SCANNED :value: 'SCANNED' - + .. py:attribute:: COMPREHENSIVE :value: 'COMPREHENSIVE' - + .. py:attribute:: COMPREHENSIVE_V2 :value: 'COMPREHENSIVE_V2' - + .. py:attribute:: COMPREHENSIVE_TABLE_MD :value: 'COMPREHENSIVE_TABLE_MD' + + .. py:attribute:: TESSERACT_FAST + :value: 'TESSERACT_FAST' -.. py:class:: DatasetConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for dataset configs - - :param is_documentset: Whether the dataset is a document set - :type is_documentset: bool - - - .. py:attribute:: is_documentset - :type: bool + .. py:class:: ParsingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Custom config for dataset parsing. @@ -1322,23 +1456,26 @@ Package Contents :param file_path_with_schema: Path to the file with schema. Defaults to None. :type file_path_with_schema: str - .. py:attribute:: escape - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: file_path_with_schema - :type: str + :type: str + + .. py:class:: DocumentProcessingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Document processing configuration. @@ -1354,46 +1491,54 @@ Package Contents :type remove_watermarks: bool :param convert_to_markdown: Whether to convert extracted text to markdown. Defaults to False. This option only takes effect when extract_bounding_boxes is True. :type convert_to_markdown: bool - + :param return_links: Whether to augment the extracted text with embedded URLs in the PDF. Defaults to False. This option only takes effect when the document is a PDF. + :type return_links: bool .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool :value: False - + .. py:attribute:: ocr_mode - :type: abacusai.api_class.enums.OcrMode + :type: abacusai.api_class.enums.OcrMode + .. py:attribute:: use_full_ocr - :type: bool - :value: None - + :type: bool + .. py:attribute:: remove_header_footer - :type: bool + :type: bool :value: False - + .. py:attribute:: remove_watermarks - :type: bool + :type: bool :value: True - + .. py:attribute:: convert_to_markdown - :type: bool + :type: bool + :value: False + + + + .. py:attribute:: return_links + :type: bool :value: False + .. py:class:: DatasetDocumentProcessingConfig - Bases: :py:obj:`DocumentProcessingConfig` + Bases: :py:obj:`DocumentProcessingConfig` Document processing configuration for dataset imports. @@ -1412,42 +1557,42 @@ Package Contents :param page_text_column: Name of the output column which contains the extracted text for each page. If not provided, no column will be created. :type page_text_column: str - .. py:attribute:: page_text_column - :type: str - :value: None + :type: str + .. py:class:: IncrementalDatabaseConnectorConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Config information for incremental datasets from database connectors :param timestamp_column: If dataset is incremental, this is the column name of the required column in the dataset. This column must contain timestamps in descending order which are used to determine the increments of the incremental dataset. :type timestamp_column: str - .. py:attribute:: timestamp_column - :type: str + :type: str + + .. py:class:: ApplicationConnectorDatasetConfig - Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` + Bases: :py:obj:`abacusai.api_class.dataset.DatasetConfig` An abstract class for dataset configs specific to application connectors. :param application_connector_type: The type of application connector :type application_connector_type: enums.ApplicationConnectorType - .. py:attribute:: application_connector_type - :type: abacusai.api_class.enums.ApplicationConnectorType + :type: abacusai.api_class.enums.ApplicationConnectorType + .. py:method:: _get_builder() :classmethod: @@ -1456,8 +1601,8 @@ Package Contents .. py:class:: ConfluenceDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Confluence Application Connector :param location: The location of the pages to fetch @@ -1469,30 +1614,34 @@ Package Contents :param extract_bounding_boxes: Whether to extract bounding boxes from the documents :type extract_bounding_boxes: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: pull_attachments - :type: bool + :type: bool + .. py:attribute:: space_key - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: GoogleAnalyticsDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Google Analytics Application Connector @@ -1503,26 +1652,29 @@ Package Contents :param end_timestamp: Unix timestamp of the end of the period that will be queried :type end_timestamp: int - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: start_timestamp - :type: int + :type: int + .. py:attribute:: end_timestamp - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: GoogleDriveDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Google Drive Application Connector @@ -1535,30 +1687,34 @@ Package Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: JiraDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Jira Application Connector @@ -1571,30 +1727,34 @@ Package Contents :param include_watchers: Fetch watchers for each issue :type include_watchers: bool - .. py:attribute:: jql - :type: str + :type: str + .. py:attribute:: custom_fields - :type: list + :type: list + .. py:attribute:: include_comments - :type: bool + :type: bool + .. py:attribute:: include_watchers - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: OneDriveDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for OneDrive Application Connector @@ -1607,30 +1767,34 @@ Package Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: SharepointDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Sharepoint Application Connector @@ -1643,48 +1807,53 @@ Package Contents :param merge_file_schemas: Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True :type merge_file_schemas: bool - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: csv_delimiter - :type: str + :type: str + .. py:attribute:: extract_bounding_boxes - :type: bool + :type: bool + .. py:attribute:: merge_file_schemas - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ZendeskDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Zendesk Application Connector :param location: The regex location of the files to fetch :type location: str - .. py:attribute:: location - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: AbacusUsageMetricsDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Abacus Usage Metrics Application Connector @@ -1693,68 +1862,74 @@ Package Contents :param include_all_feedback: Whether to include all feedback for this deployment conversation :type include_all_feedback: bool - .. py:attribute:: include_entire_conversation_history - :type: bool + :type: bool + .. py:attribute:: include_all_feedback - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: FreshserviceDatasetConfig - Bases: :py:obj:`ApplicationConnectorDatasetConfig` + Bases: :py:obj:`ApplicationConnectorDatasetConfig` Dataset config for Freshservice Application Connector - .. py:method:: __post_init__() + .. py:class:: _ApplicationConnectorDatasetConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'application_connector_type' - + .. py:attribute:: config_class_map + + .. py:class:: PredictionArguments - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for prediction arguments specific to problem type. - .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:method:: _get_builder() :classmethod: @@ -1763,8 +1938,8 @@ Package Contents .. py:class:: OptimizationPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the OPTIMIZATION problem type @@ -1775,26 +1950,29 @@ Package Contents :param include_all_assignments: If True, will return all assignments, including assignments with value 0. Default is False. :type include_all_assignments: bool - .. py:attribute:: forced_assignments - :type: dict + :type: dict + .. py:attribute:: solve_time_limit_seconds - :type: float + :type: float + .. py:attribute:: include_all_assignments - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TimeseriesAnomalyPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the TS_ANOMALY problem type @@ -1805,26 +1983,29 @@ Package Contents :param get_all_item_data: If True, anomaly detection has to be performed on all the data related to input ids :type get_all_item_data: bool - .. py:attribute:: start_timestamp - :type: str + :type: str + .. py:attribute:: end_timestamp - :type: str + :type: str + .. py:attribute:: get_all_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ChatLLMPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the CHAT_LLM problem type @@ -1841,38 +2022,44 @@ Package Contents :param ignore_documents: If True, will ignore any documents and search results, and only use the messages to generate a response. :type ignore_documents: bool - .. py:attribute:: llm_name - :type: str + :type: str + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: system_message - :type: str + :type: str + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: ignore_documents - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: RegressionPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the PREDICTIVE_MODELING problem type @@ -1881,22 +2068,24 @@ Package Contents :param explainer_type: Type of explainer to use for explanations. :type explainer_type: str - .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: ForecastingPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the FORECASTING problem type @@ -1911,34 +2100,39 @@ Package Contents :param get_item_data: If True, will return the data corresponding to items as well. :type get_item_data: bool - .. py:attribute:: num_predictions - :type: int + :type: int + .. py:attribute:: prediction_start - :type: str + :type: str + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:attribute:: get_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: CumulativeForecastingPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the CUMULATIVE_FORECASTING problem type @@ -1953,34 +2147,39 @@ Package Contents :param get_item_data: If True, will return the data corresponding to items as well. :type get_item_data: bool - .. py:attribute:: num_predictions - :type: int + :type: int + .. py:attribute:: prediction_start - :type: str + :type: str + .. py:attribute:: explain_predictions - :type: bool + :type: bool + .. py:attribute:: explainer_type - :type: str + :type: str + .. py:attribute:: get_item_data - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NaturalLanguageSearchPredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the NATURAL_LANGUAGE_SEARCH problem type @@ -1997,106 +2196,120 @@ Package Contents :param ignore_documents: If True, will ignore any documents and search results, and only use the messages to generate a response. :type ignore_documents: bool - .. py:attribute:: llm_name - :type: str + :type: str + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: system_message - :type: str + :type: str + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: ignore_documents - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: FeatureStorePredictionArguments - Bases: :py:obj:`PredictionArguments` + Bases: :py:obj:`PredictionArguments` Prediction arguments for the FEATURE_STORE problem type :param limit_results: If provided, will limit the number of results to the value specified. :type limit_results: int - .. py:attribute:: limit_results - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: _PredictionArgumentsFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + .. py:class:: VectorStoreTextEncoder - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: E5 :value: 'E5' - + .. py:attribute:: OPENAI :value: 'OPENAI' - + .. py:attribute:: SENTENCE_BERT :value: 'SENTENCE_BERT' - + .. py:attribute:: E5_SMALL :value: 'E5_SMALL' + + + .. py:attribute:: CODE_BERT + :value: 'CODE_BERT' + + .. py:class:: VectorStoreConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Config for indexing options of a document retriever. Default values of optional arguments are heuristically selected by the Abacus.AI platform based on the underlying data. @@ -2113,49 +2326,55 @@ Package Contents :param prune_vectors: Transform vectors using SVD so that the average component of vectors in the corpus are removed. :type prune_vectors: bool - .. py:attribute:: chunk_size - :type: int + :type: int + .. py:attribute:: chunk_overlap_fraction - :type: float + :type: float + .. py:attribute:: text_encoder - :type: abacusai.api_class.enums.VectorStoreTextEncoder + :type: abacusai.api_class.enums.VectorStoreTextEncoder + .. py:attribute:: chunk_size_factors - :type: list + :type: list + .. py:attribute:: score_multiplier_column - :type: str + :type: str + .. py:attribute:: prune_vectors - :type: bool + :type: bool + + .. py:data:: DocumentRetrieverConfig + + .. py:class:: ApiEnum - Bases: :py:obj:`enum.Enum` + Bases: :py:obj:`enum.Enum` Generic enumeration. Derive from this class to define new enumerations. - .. py:method:: __eq__(other) Return self==value. - .. py:method:: __hash__() Return hash(self). @@ -2164,2391 +2383,2505 @@ Package Contents .. py:class:: ProblemType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AI_AGENT :value: 'ai_agent' - + .. py:attribute:: EVENT_ANOMALY :value: 'event_anomaly' - + .. py:attribute:: CLUSTERING :value: 'clustering' - + .. py:attribute:: CLUSTERING_TIMESERIES :value: 'clustering_timeseries' - + .. py:attribute:: CUMULATIVE_FORECASTING :value: 'cumulative_forecasting' - + .. py:attribute:: NAMED_ENTITY_EXTRACTION :value: 'nlp_ner' - + .. py:attribute:: NATURAL_LANGUAGE_SEARCH :value: 'nlp_search' - + .. py:attribute:: CHAT_LLM :value: 'chat_llm' - + .. py:attribute:: SENTENCE_BOUNDARY_DETECTION :value: 'nlp_sentence_boundary_detection' - + .. py:attribute:: SENTIMENT_DETECTION :value: 'nlp_sentiment' - + .. py:attribute:: DOCUMENT_CLASSIFICATION :value: 'nlp_classification' - + .. py:attribute:: DOCUMENT_SUMMARIZATION :value: 'nlp_summarization' - + .. py:attribute:: DOCUMENT_VISUALIZATION :value: 'nlp_document_visualization' - + .. py:attribute:: PERSONALIZATION :value: 'personalization' - + .. py:attribute:: PREDICTIVE_MODELING :value: 'regression' - + .. py:attribute:: FINETUNED_LLM :value: 'finetuned_llm' - + .. py:attribute:: FORECASTING :value: 'forecasting' - + .. py:attribute:: CUSTOM_TRAINED_MODEL :value: 'plug_and_play' - + .. py:attribute:: CUSTOM_ALGORITHM :value: 'trainable_plug_and_play' - + .. py:attribute:: FEATURE_STORE :value: 'feature_store' - + .. py:attribute:: IMAGE_CLASSIFICATION :value: 'vision_classification' - + .. py:attribute:: OBJECT_DETECTION :value: 'vision_object_detection' - + .. py:attribute:: IMAGE_VALUE_PREDICTION :value: 'vision_regression' - + .. py:attribute:: MODEL_MONITORING :value: 'model_monitoring' - + .. py:attribute:: LANGUAGE_DETECTION :value: 'language_detection' - + .. py:attribute:: OPTIMIZATION :value: 'optimization' - + .. py:attribute:: PRETRAINED_MODELS :value: 'pretrained' - + .. py:attribute:: THEME_ANALYSIS :value: 'theme_analysis' - + .. py:attribute:: TS_ANOMALY :value: 'ts_anomaly' + .. py:class:: RegressionObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUC :value: 'auc' - + .. py:attribute:: ACCURACY :value: 'acc' - + .. py:attribute:: LOG_LOSS :value: 'log_loss' - + .. py:attribute:: PRECISION :value: 'precision' - + .. py:attribute:: RECALL :value: 'recall' - + .. py:attribute:: F1_SCORE :value: 'fscore' - + .. py:attribute:: MAE :value: 'mae' - + .. py:attribute:: MAPE :value: 'mape' - + .. py:attribute:: WAPE :value: 'wape' - + .. py:attribute:: RMSE :value: 'rmse' - + .. py:attribute:: R_SQUARED_COEFFICIENT_OF_DETERMINATION :value: 'r^2' + .. py:class:: RegressionTreeHPOMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: PartialDependenceAnalysis - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: RegressionAugmentationStrategy - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: SMOTE :value: 'smote' - + .. py:attribute:: RESAMPLE :value: 'resample' + .. py:class:: RegressionTargetTransform - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LOG :value: 'log' - + .. py:attribute:: QUANTILE :value: 'quantile' - + .. py:attribute:: YEO_JOHNSON :value: 'yeo-johnson' - + .. py:attribute:: BOX_COX :value: 'box-cox' + .. py:class:: RegressionTypeOfSplit - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RANDOM :value: 'Random Sampling' - + .. py:attribute:: TIMESTAMP_BASED :value: 'Timestamp Based' - + .. py:attribute:: ROW_INDICATOR_BASED :value: 'Row Indicator Based' - + .. py:attribute:: STRATIFIED_RANDOM_SAMPLING :value: 'Stratified Random Sampling' + .. py:class:: RegressionTimeSplitMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: TEST_SPLIT_PERCENTAGE_BASED :value: 'Test Split Percentage Based' - + .. py:attribute:: TEST_START_TIMESTAMP_BASED :value: 'Test Start Timestamp Based' + .. py:class:: RegressionLossFunction - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HUBER :value: 'Huber' - + .. py:attribute:: MSE :value: 'Mean Squared Error' - + .. py:attribute:: MAE :value: 'Mean Absolute Error' - + .. py:attribute:: MAPE :value: 'Mean Absolute Percentage Error' - + .. py:attribute:: MSLE :value: 'Mean Squared Logarithmic Error' - + .. py:attribute:: TWEEDIE :value: 'Tweedie' - + .. py:attribute:: CROSS_ENTROPY :value: 'Cross Entropy' - + .. py:attribute:: FOCAL_CROSS_ENTROPY :value: 'Focal Cross Entropy' - + .. py:attribute:: AUTOMATIC :value: 'Automatic' - + .. py:attribute:: CUSTOM :value: 'Custom' + .. py:class:: ExplainerType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KERNEL_EXPLAINER :value: 'KERNEL_EXPLAINER' - + .. py:attribute:: LIME_EXPLAINER :value: 'LIME_EXPLAINER' - + .. py:attribute:: TREE_EXPLAINER :value: 'TREE_EXPLAINER' - + .. py:attribute:: EBM_EXPLAINER :value: 'EBM_EXPLAINER' + .. py:class:: SamplingMethodType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: N_SAMPLING :value: 'N_SAMPLING' - + .. py:attribute:: PERCENT_SAMPLING :value: 'PERCENT_SAMPLING' + .. py:class:: MergeMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LAST_N :value: 'LAST_N' - + .. py:attribute:: TIME_WINDOW :value: 'TIME_WINDOW' + -.. py:class:: FillLogic +.. py:class:: OperatorType + Bases: :py:obj:`ApiEnum` + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: UNPIVOT + :value: 'UNPIVOT' + + + + .. py:attribute:: MARKDOWN + :value: 'MARKDOWN' + + + + .. py:attribute:: CRAWLER + :value: 'CRAWLER' + + + + .. py:attribute:: EXTRACT_DOCUMENT_DATA + :value: 'EXTRACT_DOCUMENT_DATA' + + + + +.. py:class:: MarkdownOperatorInputType + + + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. + .. py:attribute:: HTML + :value: 'HTML' + + + + +.. py:class:: FillLogic + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. .. py:attribute:: AVERAGE :value: 'average' - + .. py:attribute:: MAX :value: 'max' - + .. py:attribute:: MEDIAN :value: 'median' - + .. py:attribute:: MIN :value: 'min' - + .. py:attribute:: CUSTOM :value: 'custom' - + .. py:attribute:: BACKFILL :value: 'bfill' - + .. py:attribute:: FORWARDFILL :value: 'ffill' - + .. py:attribute:: LINEAR :value: 'linear' - + .. py:attribute:: NEAREST :value: 'nearest' + .. py:class:: BatchSize - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: BATCH_8 :value: 8 - + .. py:attribute:: BATCH_16 :value: 16 - + .. py:attribute:: BATCH_32 :value: 32 - + .. py:attribute:: BATCH_64 :value: 64 - + .. py:attribute:: BATCH_128 :value: 128 - + .. py:attribute:: BATCH_256 :value: 256 - + .. py:attribute:: BATCH_384 :value: 384 - + .. py:attribute:: BATCH_512 :value: 512 - + .. py:attribute:: BATCH_740 :value: 740 - + .. py:attribute:: BATCH_1024 :value: 1024 + .. py:class:: HolidayCalendars - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AU :value: 'AU' - + .. py:attribute:: UK :value: 'UK' - + .. py:attribute:: US :value: 'US' + .. py:class:: FileFormat - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AVRO :value: 'AVRO' - + .. py:attribute:: PARQUET :value: 'PARQUET' - + .. py:attribute:: TFRECORD :value: 'TFRECORD' - + .. py:attribute:: TSV :value: 'TSV' - + .. py:attribute:: CSV :value: 'CSV' - + .. py:attribute:: ORC :value: 'ORC' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: ODS :value: 'ODS' - + .. py:attribute:: XLS :value: 'XLS' - + .. py:attribute:: GZ :value: 'GZ' - + .. py:attribute:: ZIP :value: 'ZIP' - + .. py:attribute:: TAR :value: 'TAR' - + .. py:attribute:: DOCX :value: 'DOCX' - + .. py:attribute:: PDF :value: 'PDF' - + .. py:attribute:: RAR :value: 'RAR' - + .. py:attribute:: JPEG :value: 'JPG' - + .. py:attribute:: PNG :value: 'PNG' - + .. py:attribute:: TIF :value: 'TIFF' - + .. py:attribute:: NUMBERS :value: 'NUMBERS' - + .. py:attribute:: PPTX :value: 'PPTX' - + .. py:attribute:: PPT :value: 'PPT' - + .. py:attribute:: HTML :value: 'HTML' - + .. py:attribute:: TXT :value: 'txt' + .. py:class:: ExperimentationMode + Bases: :py:obj:`ApiEnum` - Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: RAPID :value: 'rapid' - + .. py:attribute:: THOROUGH :value: 'thorough' + .. py:class:: PersonalizationTrainingMode - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: EXPERIMENTAL :value: 'EXP' - + .. py:attribute:: PRODUCTION :value: 'PROD' + .. py:class:: PersonalizationObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NDCG :value: 'ndcg' - + .. py:attribute:: NDCG_5 :value: 'ndcg@5' - + .. py:attribute:: NDCG_10 :value: 'ndcg@10' - + .. py:attribute:: MAP :value: 'map' - + .. py:attribute:: MAP_5 :value: 'map@5' - + .. py:attribute:: MAP_10 :value: 'map@10' - + .. py:attribute:: MRR :value: 'mrr' - + .. py:attribute:: PERSONALIZATION :value: 'personalization@10' - + .. py:attribute:: COVERAGE :value: 'coverage' + .. py:class:: ForecastingObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ACCURACY :value: 'w_c_accuracy' - + .. py:attribute:: WAPE :value: 'wape' - + .. py:attribute:: MAPE :value: 'mape' - + .. py:attribute:: CMAPE :value: 'cmape' - + .. py:attribute:: RMSE :value: 'rmse' - + .. py:attribute:: CV :value: 'coefficient_of_variation' - + .. py:attribute:: BIAS :value: 'bias' - + .. py:attribute:: SRMSE :value: 'srmse' + .. py:class:: ForecastingFrequency - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HOURLY :value: '1H' - + .. py:attribute:: DAILY :value: '1D' - + .. py:attribute:: WEEKLY_SUNDAY_START :value: '1W' - + .. py:attribute:: WEEKLY_MONDAY_START :value: 'W-MON' - + .. py:attribute:: WEEKLY_SATURDAY_START :value: 'W-SAT' - + .. py:attribute:: MONTH_START :value: 'MS' - + .. py:attribute:: MONTH_END :value: '1M' - + .. py:attribute:: QUARTER_START :value: 'QS' - + .. py:attribute:: QUARTER_END :value: '1Q' - + .. py:attribute:: YEARLY :value: '1Y' + .. py:class:: ForecastingDataSplitType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'Automatic Time Based' - + .. py:attribute:: TIMESTAMP :value: 'Timestamp Based' - + .. py:attribute:: ITEM :value: 'Item Based' - + .. py:attribute:: PREDICTION_LENGTH :value: 'Force Prediction Length' + .. py:class:: ForecastingLossFunction - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: CUSTOM :value: 'Custom' - + .. py:attribute:: MEAN_ABSOLUTE_ERROR :value: 'mae' - + .. py:attribute:: NORMALIZED_MEAN_ABSOLUTE_ERROR :value: 'nmae' - + .. py:attribute:: PEAKS_MEAN_ABSOLUTE_ERROR :value: 'peaks_mae' - + .. py:attribute:: MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'stable_mape' - + .. py:attribute:: POINTWISE_ACCURACY :value: 'accuracy' - + .. py:attribute:: ROOT_MEAN_SQUARE_ERROR :value: 'rmse' - + .. py:attribute:: NORMALIZED_ROOT_MEAN_SQUARE_ERROR :value: 'nrmse' - + .. py:attribute:: ASYMMETRIC_MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'asymmetric_mape' - + .. py:attribute:: STABLE_STANDARDIZED_MEAN_ABSOLUTE_PERCENTAGE_ERROR :value: 'stable_standardized_mape_with_cmape' - + .. py:attribute:: GAUSSIAN :value: 'mle_gaussian_local' - + .. py:attribute:: GAUSSIAN_FULL_COVARIANCE :value: 'mle_gaussfullcov' - + .. py:attribute:: GUASSIAN_EXPONENTIAL :value: 'mle_gaussexp' - + .. py:attribute:: MIX_GAUSSIANS :value: 'mle_gaussmix' - + .. py:attribute:: WEIBULL :value: 'mle_weibull' - + .. py:attribute:: NEGATIVE_BINOMIAL :value: 'mle_negbinom' - + .. py:attribute:: LOG_ROOT_MEAN_SQUARE_ERROR :value: 'log_rmse' + .. py:class:: ForecastingLocalScaling - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ZSCORE :value: 'zscore' - + .. py:attribute:: SLIDING_ZSCORE :value: 'sliding_zscore' - + .. py:attribute:: LAST_POINT :value: 'lastpoint' - + .. py:attribute:: MIN_MAX :value: 'minmax' - + .. py:attribute:: MIN_STD :value: 'minstd' - + .. py:attribute:: ROBUST :value: 'robust' - + .. py:attribute:: ITEM :value: 'item' + .. py:class:: ForecastingFillMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: BACK :value: 'BACK' - + .. py:attribute:: MIDDLE :value: 'MIDDLE' - + .. py:attribute:: FUTURE :value: 'FUTURE' + .. py:class:: ForecastingQuanitlesExtensionMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DIRECT :value: 'direct' - + .. py:attribute:: QUADRATIC :value: 'quadratic' - + .. py:attribute:: ANCESTRAL_SIMULATION :value: 'simulation' + .. py:class:: TimeseriesAnomalyDataSplitType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'Automatic Time Based' - + .. py:attribute:: TIMESTAMP :value: 'Fixed Timestamp Based' + .. py:class:: TimeseriesAnomalyTypeOfAnomaly - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: HIGH_PEAK :value: 'high_peak' - + .. py:attribute:: LOW_PEAK :value: 'low_peak' + .. py:class:: TimeseriesAnomalyUseHeuristic - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ENABLE :value: 'enable' - + .. py:attribute:: DISABLE :value: 'disable' - + .. py:attribute:: AUTOMATIC :value: 'automatic' + .. py:class:: NERObjective - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: LOG_LOSS :value: 'log_loss' - + .. py:attribute:: AUC :value: 'auc' - + .. py:attribute:: PRECISION :value: 'precision' - + .. py:attribute:: RECALL :value: 'recall' - + .. py:attribute:: ANNOTATIONS_PRECISION :value: 'annotations_precision' - + .. py:attribute:: ANNOTATIONS_RECALL :value: 'annotations_recall' + .. py:class:: NERModelType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: PRETRAINED_BERT :value: 'pretrained_bert' - + .. py:attribute:: PRETRAINED_ROBERTA_27 :value: 'pretrained_roberta_27' - + .. py:attribute:: PRETRAINED_ROBERTA_43 :value: 'pretrained_roberta_43' - + .. py:attribute:: PRETRAINED_MULTILINGUAL :value: 'pretrained_multilingual' - + .. py:attribute:: LEARNED :value: 'learned' + .. py:class:: NLPDocumentFormat - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTO :value: 'auto' - + .. py:attribute:: TEXT :value: 'text' - + .. py:attribute:: DOC :value: 'doc' - + .. py:attribute:: TOKENS :value: 'tokens' + .. py:class:: SentimentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: VALENCE :value: 'valence' - + .. py:attribute:: EMOTION :value: 'emotion' + .. py:class:: ClusteringImputationMethod - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: AUTOMATIC :value: 'Automatic' - + .. py:attribute:: ZEROS :value: 'Zeros' - + .. py:attribute:: INTERPOLATE :value: 'Interpolate' + .. py:class:: ConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FILE :value: 'FILE' - + .. py:attribute:: DATABASE :value: 'DATABASE' - + .. py:attribute:: STREAMING :value: 'STREAMING' - + .. py:attribute:: APPLICATION :value: 'APPLICATION' + .. py:class:: ApplicationConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: GOOGLEANALYTICS :value: 'GOOGLEANALYTICS' - + .. py:attribute:: GOOGLEDRIVE :value: 'GOOGLEDRIVE' - + .. py:attribute:: GIT :value: 'GIT' - + .. py:attribute:: CONFLUENCE :value: 'CONFLUENCE' - + .. py:attribute:: JIRA :value: 'JIRA' - + .. py:attribute:: ONEDRIVE :value: 'ONEDRIVE' - + .. py:attribute:: ZENDESK :value: 'ZENDESK' - + .. py:attribute:: SLACK :value: 'SLACK' - + .. py:attribute:: SHAREPOINT :value: 'SHAREPOINT' - + .. py:attribute:: TEAMS :value: 'TEAMS' - + .. py:attribute:: ABACUSUSAGEMETRICS :value: 'ABACUSUSAGEMETRICS' - + .. py:attribute:: MICROSOFTAUTH :value: 'MICROSOFTAUTH' - + .. py:attribute:: FRESHSERVICE :value: 'FRESHSERVICE' - + .. py:attribute:: ZENDESKSUNSHINEMESSAGING :value: 'ZENDESKSUNSHINEMESSAGING' + .. py:class:: StreamingConnectorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KAFKA :value: 'KAFKA' + .. py:class:: PythonFunctionArgumentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FEATURE_GROUP :value: 'FEATURE_GROUP' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: DATASET_ID :value: 'DATASET_ID' - + .. py:attribute:: MODEL_ID :value: 'MODEL_ID' - + .. py:attribute:: FEATURE_GROUP_ID :value: 'FEATURE_GROUP_ID' - + .. py:attribute:: MONITOR_ID :value: 'MONITOR_ID' - + .. py:attribute:: BATCH_PREDICTION_ID :value: 'BATCH_PREDICTION_ID' - + .. py:attribute:: DEPLOYMENT_ID :value: 'DEPLOYMENT_ID' + .. py:class:: PythonFunctionOutputArgumentType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NTEGER :value: 'INTEGER' - + .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: JSON :value: 'JSON' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: DATASET_ID :value: 'DATASET_ID' - + .. py:attribute:: MODEL_ID :value: 'MODEL_ID' - + .. py:attribute:: FEATURE_GROUP_ID :value: 'FEATURE_GROUP_ID' - + .. py:attribute:: MONITOR_ID :value: 'MONITOR_ID' - + .. py:attribute:: BATCH_PREDICTION_ID :value: 'BATCH_PREDICTION_ID' - + .. py:attribute:: DEPLOYMENT_ID :value: 'DEPLOYMENT_ID' - + .. py:attribute:: ANY :value: 'ANY' + .. py:class:: LLMName - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: OPENAI_GPT4 :value: 'OPENAI_GPT4' - + .. py:attribute:: OPENAI_GPT4_32K :value: 'OPENAI_GPT4_32K' - + .. py:attribute:: OPENAI_GPT4_128K :value: 'OPENAI_GPT4_128K' - + .. py:attribute:: OPENAI_GPT4_128K_LATEST :value: 'OPENAI_GPT4_128K_LATEST' - + .. py:attribute:: OPENAI_GPT4_VISION :value: 'OPENAI_GPT4_VISION' - + .. py:attribute:: OPENAI_GPT4O :value: 'OPENAI_GPT4O' - + .. py:attribute:: OPENAI_GPT3_5 :value: 'OPENAI_GPT3_5' - + .. py:attribute:: OPENAI_GPT3_5_TEXT :value: 'OPENAI_GPT3_5_TEXT' - + .. py:attribute:: LLAMA3_LARGE_CHAT :value: 'LLAMA3_LARGE_CHAT' - + .. py:attribute:: GROQ_LLAMA3_LARGE_CHAT :value: 'GROQ_LLAMA3_LARGE_CHAT' - + .. py:attribute:: CLAUDE_V2_1 :value: 'CLAUDE_V2_1' - + .. py:attribute:: CLAUDE_V3_OPUS :value: 'CLAUDE_V3_OPUS' - + .. py:attribute:: CLAUDE_V3_SONNET :value: 'CLAUDE_V3_SONNET' - + .. py:attribute:: CLAUDE_V3_HAIKU :value: 'CLAUDE_V3_HAIKU' - + .. py:attribute:: ABACUS_GIRAFFE :value: 'ABACUS_GIRAFFE' - + .. py:attribute:: ABACUS_GIRAFFE_LARGE :value: 'ABACUS_GIRAFFE_LARGE' - + .. py:attribute:: LLAMA2_CHAT :value: 'LLAMA2_CHAT' - + .. py:attribute:: PALM :value: 'PALM' - + .. py:attribute:: PALM_TEXT :value: 'PALM_TEXT' - + .. py:attribute:: GEMINI_PRO :value: 'GEMINI_PRO' - + .. py:attribute:: GEMINI_1_5_PRO :value: 'GEMINI_1_5_PRO' - + .. py:attribute:: MIXTRAL_CHAT :value: 'MIXTRAL_CHAT' - + .. py:attribute:: MISTRAL_MEDIUM :value: 'MISTRAL_MEDIUM' - + .. py:attribute:: ABACUS_SMAUG3 :value: 'ABACUS_SMAUG3' + .. py:class:: MonitorAlertType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ACCURACY_BELOW_THRESHOLD :value: 'AccuracyBelowThreshold' - + .. py:attribute:: FEATURE_DRIFT :value: 'FeatureDrift' - + .. py:attribute:: DATA_INTEGRITY_VIOLATIONS :value: 'DataIntegrityViolations' - + .. py:attribute:: BIAS_VIOLATIONS :value: 'BiasViolations' - + .. py:attribute:: HISTORY_LENGTH_DRIFT :value: 'HistoryLengthDrift' - + .. py:attribute:: TARGET_DRIFT :value: 'TargetDrift' - + .. py:attribute:: PREDICTION_COUNT :value: 'PredictionCount' + .. py:class:: FeatureDriftType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: KL :value: 'kl' - + .. py:attribute:: KS :value: 'ks' - + .. py:attribute:: WS :value: 'ws' - + .. py:attribute:: JS :value: 'js' - + .. py:attribute:: PSI :value: 'psi' - + .. py:attribute:: CHI_SQUARE :value: 'chi_square' - + .. py:attribute:: CSI :value: 'csi' + .. py:class:: DataIntegrityViolationType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: NULL_VIOLATIONS :value: 'null_violations' - + .. py:attribute:: RANGE_VIOLATIONS :value: 'range_violations' - + .. py:attribute:: CATEGORICAL_RANGE_VIOLATION :value: 'categorical_range_violations' - + .. py:attribute:: TOTAL_VIOLATIONS :value: 'total_violations' + .. py:class:: BiasType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEMOGRAPHIC_PARITY :value: 'demographic_parity' - + .. py:attribute:: EQUAL_OPPORTUNITY :value: 'equal_opportunity' - + .. py:attribute:: GROUP_BENEFIT_EQUALITY :value: 'group_benefit' - + .. py:attribute:: TOTAL :value: 'total' + .. py:class:: AlertActionType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: EMAIL :value: 'Email' + .. py:class:: PythonFunctionType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FEATURE_GROUP :value: 'FEATURE_GROUP' - + .. py:attribute:: PLOTLY_FIG :value: 'PLOTLY_FIG' - + .. py:attribute:: STEP_FUNCTION :value: 'STEP_FUNCTION' + .. py:class:: EvalArtifactType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: FORECASTING_ACCURACY :value: 'bar_chart' - + .. py:attribute:: FORECASTING_VOLUME :value: 'bar_chart_volume' - + .. py:attribute:: FORECASTING_HISTORY_LENGTH_ACCURACY :value: 'bar_chart_accuracy_by_history' + .. py:class:: FieldDescriptorType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: STRING :value: 'STRING' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: DATETIME :value: 'DATETIME' - + .. py:attribute:: DATE :value: 'DATE' + .. py:class:: WorkflowNodeInputType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: USER_INPUT :value: 'USER_INPUT' - + .. py:attribute:: WORKFLOW_VARIABLE :value: 'WORKFLOW_VARIABLE' + .. py:class:: WorkflowNodeOutputType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ATTACHMENT :value: 'ATTACHMENT' - + .. py:attribute:: BOOLEAN :value: 'BOOLEAN' - + .. py:attribute:: FLOAT :value: 'FLOAT' - + .. py:attribute:: INTEGER :value: 'INTEGER' - + .. py:attribute:: DICT :value: 'DICT' - + .. py:attribute:: LIST :value: 'LIST' - + .. py:attribute:: STRING :value: 'STRING' + .. py:class:: StdDevThresholdType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: ABSOLUTE :value: 'ABSOLUTE' - + .. py:attribute:: PERCENTILE :value: 'PERCENTILE' - + .. py:attribute:: STDDEV :value: 'STDDEV' + .. py:class:: DataType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: INTEGER :value: 'integer' - + .. py:attribute:: FLOAT :value: 'float' - + .. py:attribute:: STRING :value: 'string' - + .. py:attribute:: DATE :value: 'date' - + .. py:attribute:: DATETIME :value: 'datetime' - + .. py:attribute:: BOOLEAN :value: 'boolean' - + .. py:attribute:: LIST :value: 'list' - + .. py:attribute:: STRUCT :value: 'struct' - + .. py:attribute:: NULL :value: 'null' + + + .. py:attribute:: BINARY + :value: 'binary' + + .. py:class:: AgentInterface - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: DEFAULT :value: 'DEFAULT' - + .. py:attribute:: CHAT :value: 'CHAT' + .. py:class:: ProjectConfigType - Bases: :py:obj:`ApiEnum` + Bases: :py:obj:`ApiEnum` Generic enumeration. Derive from this class to define new enumerations. - .. py:attribute:: CONSTRAINTS :value: 'CONSTRAINTS' + + + .. py:attribute:: CHAT_FEEDBACK + :value: 'CHAT_FEEDBACK' + .. py:attribute:: REVIEW_MODE :value: 'REVIEW_MODE' + + + +.. py:class:: CPUSize + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: SMALL + :value: 'small' + + + + .. py:attribute:: MEDIUM + :value: 'medium' + + + + .. py:attribute:: LARGE + :value: 'large' + + + + +.. py:class:: MemorySize + + + Bases: :py:obj:`ApiEnum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: SMALL + :value: 16 + + + + .. py:attribute:: MEDIUM + :value: 32 + + + + .. py:attribute:: LARGE + :value: 64 + + + + .. py:attribute:: XLARGE + :value: 128 + + + + .. py:method:: from_value(value) + :classmethod: + .. py:class:: SamplingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for the sampling config of a feature group - .. py:attribute:: sampling_method - :type: abacusai.api_class.enums.SamplingMethodType + :type: abacusai.api_class.enums.SamplingMethodType + .. py:method:: _get_builder() :classmethod: - .. py:method:: __post_init__() + .. py:class:: NSamplingConfig - Bases: :py:obj:`SamplingConfig` + Bases: :py:obj:`SamplingConfig` The number of distinct values of the key columns to include in the sample, or number of rows if key columns not specified. - :param sampling_method: N_SAMPLING - :type sampling_method: SamplingMethodType :param sample_count: The number of rows to include in the sample :type sample_count: int :param key_columns: The feature(s) to use as the key(s) when sampling :type key_columns: List[str] - .. py:attribute:: sample_count - :type: int + :type: int + .. py:attribute:: key_columns - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: PercentSamplingConfig - Bases: :py:obj:`SamplingConfig` + Bases: :py:obj:`SamplingConfig` The fraction of distinct values of the feature group to include in the sample. - :param sampling_method: PERCENT_SAMPLING - :type sampling_method: SamplingMethodType :param sample_percent: The percentage of the rows to sample :type sample_percent: float :param key_columns: The feature(s) to use as the key(s) when sampling :type key_columns: List[str] - .. py:attribute:: sample_percent - :type: float + :type: float + .. py:attribute:: key_columns - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: _SamplingConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_class_key :value: 'sampling_method' - + .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_map + + .. py:class:: MergeConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for the merge config of a feature group - .. py:attribute:: merge_mode - :type: abacusai.api_class.enums.MergeMode + :type: abacusai.api_class.enums.MergeMode + .. py:method:: _get_builder() :classmethod: - .. py:method:: __post_init__() + .. py:class:: LastNMergeConfig - Bases: :py:obj:`MergeConfig` + Bases: :py:obj:`MergeConfig` Merge LAST N chunks/versions of an incremental dataset. - :param merge_mode: LAST_N - :type merge_mode: MergeMode :param num_versions: The number of versions to merge. num_versions == 0 means merge all versions. :type num_versions: int :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. :type include_version_timestamp_column: bool - .. py:attribute:: num_versions - :type: int + :type: int + .. py:attribute:: include_version_timestamp_column - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: TimeWindowMergeConfig - Bases: :py:obj:`MergeConfig` + Bases: :py:obj:`MergeConfig` Merge rows within a given timewindow of the most recent timestamp - :param merge_mode: TIME_WINDOW - :type merge_mode: MergeMode :param feature_name: Time based column to index on :type feature_name: str :param time_window_size_ms: Range of merged rows will be [MAX_TIME - time_window_size_ms, MAX_TIME] @@ -4556,69 +4889,289 @@ Package Contents :param include_version_timestamp_column: If set, include a column with the creation timestamp of source FG versions. :type include_version_timestamp_column: bool - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: time_window_size_ms - :type: int + :type: int + .. py:attribute:: include_version_timestamp_column - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _MergeConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_class_key :value: 'merge_mode' + + + .. py:attribute:: config_abstract_class + + + + .. py:attribute:: config_class_map + + + + +.. py:class:: OperatorConfig + + + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + + Configuration for a template Feature Group Operation + + .. py:attribute:: operator_type + :type: abacusai.api_class.enums.OperatorType + + + + .. py:method:: _get_builder() + :classmethod: + + + .. py:method:: __post_init__() + + + +.. py:class:: UnpivotConfig + + + Bases: :py:obj:`OperatorConfig` + + Unpivot Columns in a FeatureGroup. + + :param columns: Which columns to unpivot. + :type columns: List[str] + :param index_column: Name of new column containing the unpivoted column names as its values + :type index_column: str + :param value_column: Name of new column containing the row values that were unpivoted. + :type value_column: str + :param exclude: If True, the unpivoted columns are all the columns EXCEPT the ones in the columns argument. Default is False. + :type exclude: bool + + .. py:attribute:: columns + :type: List[str] + + + + .. py:attribute:: index_column + :type: str + + + + .. py:attribute:: value_column + :type: str + + + + .. py:attribute:: exclude + :type: bool + + + + .. py:method:: __post_init__() + + + +.. py:class:: MarkdownConfig + + + Bases: :py:obj:`OperatorConfig` + + Transform a input column to a markdown column. + + :param input_column: Name of input column to transform. + :type input_column: str + :param output_column: Name of output column to store transformed data. + :type output_column: str + :param input_column_type: Type of input column to transform. + :type input_column_type: MarkdownOperatorInputType + + .. py:attribute:: input_column + :type: str + + + + .. py:attribute:: output_column + :type: str + + + + .. py:attribute:: input_column_type + :type: abacusai.api_class.enums.MarkdownOperatorInputType + + + + .. py:method:: __post_init__() + + + +.. py:class:: CrawlerTransformConfig + + + Bases: :py:obj:`OperatorConfig` + + Transform a input column of urls to html text + + :param input_column: Name of input column to transform. + :type input_column: str + :param output_column: Name of output column to store transformed data. + :type output_column: str + :param depth_column: Increasing depth explores more links, capturing more content + :type depth_column: str + :param disable_host_restriction: If True, will not restrict crawling to the same host. + :type disable_host_restriction: bool + :param honour_website_rules: If True, will respect robots.txt rules. + :type honour_website_rules: bool + :param user_agent: If provided, will use this user agent instead of randomly selecting one. + :type user_agent: str + + .. py:attribute:: input_column + :type: str + + + + .. py:attribute:: output_column + :type: str + + + + .. py:attribute:: depth_column + :type: str + + + + .. py:attribute:: input_column_type + :type: str + + + + .. py:attribute:: crawl_depth + :type: int + + + + .. py:attribute:: disable_host_restriction + :type: bool + + + + .. py:attribute:: honour_website_rules + :type: bool + + + + .. py:attribute:: user_agent + :type: str + + + + .. py:method:: __post_init__() + + + +.. py:class:: ExtractDocumentDataConfig + + + Bases: :py:obj:`OperatorConfig` + + Extracts data from documents. + + :param doc_id_column: Name of input document ID column. + :type doc_id_column: str + :param document_column: Name of the input document column which contains the page infos. This column will be transformed to include the document processing config in the output feature group. + :type document_column: str + :param document_processing_config: Document processing configuration. + :type document_processing_config: DocumentProcessingConfig + + .. py:attribute:: doc_id_column + :type: str + + + + .. py:attribute:: document_column + :type: str + + + + .. py:attribute:: document_processing_config + :type: abacusai.api_class.dataset.DocumentProcessingConfig + + + + .. py:method:: __post_init__() + + + +.. py:class:: _OperatorConfigFactory + + + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + A class to select and return the the correct type of Operator Config based on a serialized OperatorConfig instance. .. py:attribute:: config_abstract_class + + + .. py:attribute:: config_class_key + :value: 'operator_type' + + .. py:attribute:: config_class_map + + .. py:class:: TrainingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for the training config options used to train the model. - .. py:attribute:: _upper_snake_case_keys - :type: bool + :type: bool + .. py:attribute:: _support_kwargs - :type: bool + :type: bool + .. py:attribute:: kwargs - :type: dict + :type: dict + .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType + :type: abacusai.api_class.enums.ProblemType + .. py:attribute:: algorithm - :type: str + :type: str + .. py:method:: _get_builder() :classmethod: @@ -4627,8 +5180,8 @@ Package Contents .. py:class:: PersonalizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the PERSONALIZATION problem type @@ -4707,162 +5260,199 @@ Package Contents :param item_query_column: Name of column in the item catalog that will be matched to the query column in the interactions table. :type item_query_column: str - .. py:attribute:: objective - :type: abacusai.api_class.enums.PersonalizationObjective + :type: abacusai.api_class.enums.PersonalizationObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.PersonalizationObjective + :type: abacusai.api_class.enums.PersonalizationObjective + .. py:attribute:: training_mode - :type: abacusai.api_class.enums.PersonalizationTrainingMode + :type: abacusai.api_class.enums.PersonalizationTrainingMode + .. py:attribute:: target_action_types - :type: List[str] + :type: List[str] + .. py:attribute:: target_action_weights - :type: Dict[str, float] + :type: Dict[str, float] + .. py:attribute:: session_event_types - :type: List[str] + :type: List[str] + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: recent_days_for_training - :type: int + :type: int + .. py:attribute:: training_start_date - :type: str + :type: str + .. py:attribute:: test_on_user_split - :type: bool + :type: bool + .. py:attribute:: test_split_on_last_k_items - :type: bool + :type: bool + .. py:attribute:: test_last_items_length - :type: int + :type: int + .. py:attribute:: test_window_length_hours - :type: int + :type: int + .. py:attribute:: explicit_time_split - :type: bool + :type: bool + .. py:attribute:: test_row_indicator - :type: str + :type: str + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: sequential_training - :type: bool + :type: bool + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: optimized_event_type - :type: str + :type: str + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: disable_transformer - :type: bool + :type: bool + .. py:attribute:: disable_gpu - :type: bool + :type: bool + .. py:attribute:: filter_history - :type: bool + :type: bool + .. py:attribute:: action_types_exclusion_days - :type: Dict[str, float] + :type: Dict[str, float] + .. py:attribute:: max_history_length - :type: int + :type: int + .. py:attribute:: compute_rerank_metrics - :type: bool + :type: bool + .. py:attribute:: add_time_features - :type: bool + :type: bool + .. py:attribute:: disable_timestamp_scalar_features - :type: bool + :type: bool + .. py:attribute:: compute_session_metrics - :type: bool + :type: bool + .. py:attribute:: query_column - :type: str + :type: str + .. py:attribute:: item_query_column - :type: str + :type: str + .. py:attribute:: use_user_id_feature - :type: bool + :type: bool + .. py:attribute:: session_dedupe_mins - :type: float + :type: float + .. py:attribute:: max_user_history_len_percentile - :type: int + :type: int + .. py:attribute:: downsample_item_popularity_percentile - :type: float + :type: float + .. py:attribute:: min_item_history - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: RegressionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the PREDICTIVE_MODELING problem type @@ -4948,179 +5538,227 @@ Package Contents :type custom_metrics: List[str] :param partial_dependence_analysis: Specify whether to run partial dependence plots for all features or only some features. :type partial_dependence_analysis: PartialDependenceAnalysis - + :param do_masked_language_model_pretraining: Specify whether to run a masked language model unsupervised pretraining step before supervized training in certain supported algorithms which use BERT-like backbones. + :type do_masked_language_model_pretraining: bool .. py:attribute:: objective - :type: abacusai.api_class.enums.RegressionObjective + :type: abacusai.api_class.enums.RegressionObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.RegressionObjective + :type: abacusai.api_class.enums.RegressionObjective + .. py:attribute:: tree_hpo_mode - :type: abacusai.api_class.enums.RegressionTreeHPOMode + :type: abacusai.api_class.enums.RegressionTreeHPOMode + .. py:attribute:: partial_dependence_analysis - :type: abacusai.api_class.enums.PartialDependenceAnalysis + :type: abacusai.api_class.enums.PartialDependenceAnalysis + .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.RegressionTypeOfSplit + :type: abacusai.api_class.enums.RegressionTypeOfSplit + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: disable_test_val_fold - :type: bool + :type: bool + .. py:attribute:: k_fold_cross_validation - :type: bool + :type: bool + .. py:attribute:: num_cv_folds - :type: int + :type: int + .. py:attribute:: timestamp_based_splitting_column - :type: str + :type: str + .. py:attribute:: timestamp_based_splitting_method - :type: abacusai.api_class.enums.RegressionTimeSplitMethod + :type: abacusai.api_class.enums.RegressionTimeSplitMethod + .. py:attribute:: test_splitting_timestamp - :type: str + :type: str + .. py:attribute:: sampling_unit_keys - :type: List[str] + :type: List[str] + .. py:attribute:: test_row_indicator - :type: str + :type: str + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: rebalance_classes - :type: bool + :type: bool + .. py:attribute:: rare_class_augmentation_threshold - :type: float + :type: float + .. py:attribute:: augmentation_strategy - :type: abacusai.api_class.enums.RegressionAugmentationStrategy + :type: abacusai.api_class.enums.RegressionAugmentationStrategy + .. py:attribute:: training_rows_downsample_ratio - :type: float + :type: float + .. py:attribute:: active_labels_column - :type: str + :type: str + .. py:attribute:: min_categorical_count - :type: int + :type: int + .. py:attribute:: sample_weight - :type: str + :type: str + .. py:attribute:: numeric_clipping_percentile - :type: float + :type: float + .. py:attribute:: target_transform - :type: abacusai.api_class.enums.RegressionTargetTransform + :type: abacusai.api_class.enums.RegressionTargetTransform + .. py:attribute:: ignore_datetime_features - :type: bool + :type: bool + .. py:attribute:: max_text_words - :type: int + :type: int + .. py:attribute:: perform_feature_selection - :type: bool + :type: bool + .. py:attribute:: feature_selection_intensity - :type: int + :type: int + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: pretrained_model_name - :type: str + :type: str + .. py:attribute:: is_multilingual - :type: bool + :type: bool + + + .. py:attribute:: do_masked_language_model_pretraining + :type: bool + + .. py:attribute:: loss_function - :type: abacusai.api_class.enums.RegressionLossFunction + :type: abacusai.api_class.enums.RegressionLossFunction + .. py:attribute:: loss_parameters - :type: str + :type: str + .. py:attribute:: target_encode_categoricals - :type: bool + :type: bool + .. py:attribute:: drop_original_categoricals - :type: bool + :type: bool + .. py:attribute:: monotonically_increasing_features - :type: List[str] + :type: List[str] + .. py:attribute:: monotonically_decreasing_features - :type: List[str] + :type: List[str] + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: custom_loss_functions - :type: List[str] + :type: List[str] + .. py:attribute:: custom_metrics - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: ForecastingTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the FORECASTING problem type @@ -5247,262 +5885,324 @@ Package Contents :type custom_metrics: List[str] :param return_fractional_forecasts: Use this to return fractional forecast values while prediction - .. py:attribute:: prediction_length - :type: int + :type: int + .. py:attribute:: objective - :type: abacusai.api_class.enums.ForecastingObjective + :type: abacusai.api_class.enums.ForecastingObjective + .. py:attribute:: sort_objective - :type: abacusai.api_class.enums.ForecastingObjective + :type: abacusai.api_class.enums.ForecastingObjective + .. py:attribute:: forecast_frequency - :type: abacusai.api_class.enums.ForecastingFrequency + :type: abacusai.api_class.enums.ForecastingFrequency + .. py:attribute:: probability_quantiles - :type: List[float] + :type: List[float] + .. py:attribute:: force_prediction_length - :type: bool + :type: bool + .. py:attribute:: filter_items - :type: bool + :type: bool + .. py:attribute:: enable_feature_selection - :type: bool + :type: bool + .. py:attribute:: enable_padding - :type: bool + :type: bool + .. py:attribute:: enable_cold_start - :type: bool + :type: bool + .. py:attribute:: enable_multiple_backtests - :type: bool + :type: bool + .. py:attribute:: num_backtesting_windows - :type: int + :type: int + .. py:attribute:: backtesting_window_step_size - :type: int + :type: int + .. py:attribute:: full_data_retraining - :type: bool + :type: bool + .. py:attribute:: additional_forecast_keys - :type: List[str] + :type: List[str] + .. py:attribute:: experimentation_mode - :type: abacusai.api_class.enums.ExperimentationMode + :type: abacusai.api_class.enums.ExperimentationMode + .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.ForecastingDataSplitType + :type: abacusai.api_class.enums.ForecastingDataSplitType + .. py:attribute:: test_by_item - :type: bool + :type: bool + .. py:attribute:: test_start - :type: str + :type: str + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: loss_function - :type: abacusai.api_class.enums.ForecastingLossFunction + :type: abacusai.api_class.enums.ForecastingLossFunction + .. py:attribute:: underprediction_weight - :type: float + :type: float + .. py:attribute:: disable_networks_without_analytic_quantiles - :type: bool + :type: bool + .. py:attribute:: initial_learning_rate - :type: float + :type: float + .. py:attribute:: l2_regularization_factor - :type: float + :type: float + .. py:attribute:: dropout_rate - :type: int + :type: int + .. py:attribute:: recurrent_layers - :type: int + :type: int + .. py:attribute:: recurrent_units - :type: int + :type: int + .. py:attribute:: convolutional_layers - :type: int + :type: int + .. py:attribute:: convolution_filters - :type: int + :type: int + .. py:attribute:: local_scaling_mode - :type: abacusai.api_class.enums.ForecastingLocalScaling + :type: abacusai.api_class.enums.ForecastingLocalScaling + .. py:attribute:: zero_predictor - :type: bool + :type: bool + .. py:attribute:: skip_missing - :type: bool + :type: bool + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: batch_renormalization - :type: bool + :type: bool + .. py:attribute:: history_length - :type: int + :type: int + .. py:attribute:: prediction_step_size - :type: int + :type: int + .. py:attribute:: training_point_overlap - :type: float + :type: float + .. py:attribute:: max_scale_context - :type: int + :type: int + .. py:attribute:: quantiles_extension_method - :type: abacusai.api_class.enums.ForecastingQuanitlesExtensionMethod + :type: abacusai.api_class.enums.ForecastingQuanitlesExtensionMethod + .. py:attribute:: number_of_samples - :type: int + :type: int + .. py:attribute:: symmetrize_quantiles - :type: bool + :type: bool + .. py:attribute:: use_log_transforms - :type: bool + :type: bool + .. py:attribute:: smooth_history - :type: float + :type: float + .. py:attribute:: local_scale_target - :type: bool + :type: bool + .. py:attribute:: use_clipping - :type: bool + :type: bool + .. py:attribute:: timeseries_weight_column - :type: str + :type: str + .. py:attribute:: item_attributes_weight_column - :type: str + :type: str + .. py:attribute:: use_timeseries_weights_in_objective - :type: bool + :type: bool + .. py:attribute:: use_item_weights_in_objective - :type: bool + :type: bool + .. py:attribute:: skip_timeseries_weight_scaling - :type: bool + :type: bool + .. py:attribute:: timeseries_loss_weight_column - :type: str + :type: str + .. py:attribute:: use_item_id - :type: bool + :type: bool + .. py:attribute:: use_all_item_totals - :type: bool + :type: bool + .. py:attribute:: handle_zeros_as_missing_values - :type: bool + :type: bool + .. py:attribute:: datetime_holiday_calendars - :type: List[abacusai.api_class.enums.HolidayCalendars] + :type: List[abacusai.api_class.enums.HolidayCalendars] + .. py:attribute:: fill_missing_values - :type: List[dict] + :type: List[dict] + .. py:attribute:: enable_clustering - :type: bool + :type: bool + .. py:attribute:: data_split_feature_group_table_name - :type: str + :type: str + .. py:attribute:: custom_loss_functions - :type: List[str] + :type: List[str] + .. py:attribute:: custom_metrics - :type: List[str] + :type: List[str] + .. py:attribute:: return_fractional_forecasts - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: NamedEntityExtractionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the NAMED_ENTITY_EXTRACTION problem type @@ -5523,62 +6223,57 @@ Package Contents :param enhanced_ocr: Enhanced text extraction from predicted digital documents :type enhanced_ocr: bool - .. py:attribute:: llm_for_ner - :type: abacusai.api_class.enums.LLMName - :value: None - + :type: abacusai.api_class.enums.LLMName + .. py:attribute:: test_split - :type: int - :value: None - + :type: int + .. py:attribute:: test_row_indicator - :type: str - :value: None - + :type: str + .. py:attribute:: active_labels_column - :type: str - :value: None - + :type: str + .. py:attribute:: document_format - :type: abacusai.api_class.enums.NLPDocumentFormat - :value: None - + :type: abacusai.api_class.enums.NLPDocumentFormat + .. py:attribute:: minimum_bounding_box_overlap_ratio - :type: float + :type: float :value: 0.0 - + .. py:attribute:: save_predicted_pdf - :type: bool + :type: bool :value: True - + .. py:attribute:: enhanced_ocr - :type: bool + :type: bool :value: False - + .. py:method:: __post_init__() + .. py:class:: NaturalLanguageSearchTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the NATURAL_LANGUAGE_SEARCH problem type @@ -5595,38 +6290,44 @@ Package Contents :param index_fraction: Fraction of the chunk to use for indexing. :type index_fraction: float - .. py:attribute:: abacus_internal_model - :type: bool + :type: bool + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: larger_embeddings - :type: bool + :type: bool + .. py:attribute:: search_chunk_size - :type: int + :type: int + .. py:attribute:: index_fraction - :type: float + :type: float + .. py:attribute:: chunk_overlap_fraction - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: ChatLLMTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CHAT_LLM problem type @@ -5674,110 +6375,134 @@ Package Contents :param enable_code_execution: Enable python code execution in the ChatLLM. This equips the LLM with a python kernel in which all its code is executed. :type enable_code_execution: bool - .. py:attribute:: document_retrievers - :type: List[str] + :type: List[str] + .. py:attribute:: num_completion_tokens - :type: int + :type: int + .. py:attribute:: temperature - :type: float + :type: float + .. py:attribute:: retrieval_columns - :type: list + :type: list + .. py:attribute:: filter_columns - :type: list + :type: list + .. py:attribute:: include_general_knowledge - :type: bool + :type: bool + .. py:attribute:: enable_web_search - :type: bool + :type: bool + .. py:attribute:: behavior_instructions - :type: str + :type: str + .. py:attribute:: response_instructions - :type: str + :type: str + .. py:attribute:: enable_llm_rewrite - :type: bool + :type: bool + .. py:attribute:: column_filtering_instructions - :type: str + :type: str + .. py:attribute:: keyword_requirement_instructions - :type: str + :type: str + .. py:attribute:: query_rewrite_instructions - :type: str + :type: str + .. py:attribute:: max_search_results - :type: int + :type: int + .. py:attribute:: data_feature_group_ids - :type: List[str] + :type: List[str] + .. py:attribute:: data_prompt_context - :type: str + :type: str + .. py:attribute:: hide_generated_sql - :type: bool + :type: bool + .. py:attribute:: disable_data_summarization - :type: bool + :type: bool + .. py:attribute:: search_score_cutoff - :type: float + :type: float + .. py:attribute:: database_connector_id - :type: str + :type: str + .. py:attribute:: database_connector_tables - :type: List[str] + :type: List[str] + .. py:attribute:: enable_code_execution - :type: bool + :type: bool + .. py:attribute:: metadata_columns - :type: list + :type: list + .. py:attribute:: lookup_rewrite_instructions - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: SentenceBoundaryDetectionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the SENTENCE_BOUNDARY_DETECTION problem type @@ -5788,26 +6513,29 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: SentimentDetectionTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the SENTIMENT_DETECTION problem type @@ -5822,34 +6550,39 @@ Package Contents :param compute_metrics: Whether to compute metrics. :type compute_metrics: bool - .. py:attribute:: sentiment_type - :type: abacusai.api_class.enums.SentimentType + :type: abacusai.api_class.enums.SentimentType + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:attribute:: compute_metrics - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: DocumentClassificationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_CLASSIFICATION problem type @@ -5862,30 +6595,34 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: zero_shot_hypotheses - :type: List[str] + :type: List[str] + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: DocumentSummarizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_SUMMARIZATION problem type @@ -5896,26 +6633,29 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: DocumentVisualizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the DOCUMENT_VISUALIZATION problem type @@ -5926,44 +6666,48 @@ Package Contents :param batch_size: Batch size for neural network. :type batch_size: BatchSize - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: dropout_rate - :type: float + :type: float + .. py:attribute:: batch_size - :type: abacusai.api_class.enums.BatchSize + :type: abacusai.api_class.enums.BatchSize + .. py:method:: __post_init__() + .. py:class:: ClusteringTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CLUSTERING problem type :param num_clusters_selection: Number of clusters. If None, will be selected automatically. :type num_clusters_selection: int - .. py:attribute:: num_clusters_selection - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: ClusteringTimeseriesTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CLUSTERING_TIMESERIES problem type @@ -5972,40 +6716,43 @@ Package Contents :param imputation: Imputation method for missing values. :type imputation: ClusteringImputationMethod - .. py:attribute:: num_clusters_selection - :type: int + :type: int + .. py:attribute:: imputation - :type: abacusai.api_class.enums.ClusteringImputationMethod + :type: abacusai.api_class.enums.ClusteringImputationMethod + .. py:method:: __post_init__() + .. py:class:: EventAnomalyTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the EVENT_ANOMALY problem type :param anomaly_fraction: The fraction of the dataset to classify as anomalous, between 0 and 0.5 :type anomaly_fraction: float - .. py:attribute:: anomaly_fraction - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: TimeseriesAnomalyTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the TS_ANOMALY problem type @@ -6030,54 +6777,64 @@ Package Contents :param threshold_score: Threshold score for anomaly detection :type threshold_score: float - .. py:attribute:: type_of_split - :type: abacusai.api_class.enums.TimeseriesAnomalyDataSplitType + :type: abacusai.api_class.enums.TimeseriesAnomalyDataSplitType + .. py:attribute:: test_start - :type: str + :type: str + .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: fill_missing_values - :type: List[dict] + :type: List[dict] + .. py:attribute:: handle_zeros_as_missing_values - :type: bool + :type: bool + .. py:attribute:: timeseries_frequency - :type: str + :type: str + .. py:attribute:: min_samples_in_normal_region - :type: int + :type: int + .. py:attribute:: anomaly_type - :type: abacusai.api_class.enums.TimeseriesAnomalyTypeOfAnomaly + :type: abacusai.api_class.enums.TimeseriesAnomalyTypeOfAnomaly + .. py:attribute:: hyperparameter_calculation_with_heuristics - :type: abacusai.api_class.enums.TimeseriesAnomalyUseHeuristic + :type: abacusai.api_class.enums.TimeseriesAnomalyUseHeuristic + .. py:attribute:: threshold_score - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: CumulativeForecastingTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUMULATIVE_FORECASTING problem type @@ -6094,49 +6851,55 @@ Package Contents :param predict_residuals: Predict residuals instead of totals at each prediction step. :type predict_residuals: bool - .. py:attribute:: test_split - :type: int + :type: int + .. py:attribute:: historical_frequency - :type: str + :type: str + .. py:attribute:: cumulative_prediction_lengths - :type: List[int] + :type: List[int] + .. py:attribute:: skip_input_transform - :type: bool + :type: bool + .. py:attribute:: skip_target_transform - :type: bool + :type: bool + .. py:attribute:: predict_residuals - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: ThemeAnalysisTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the THEME ANALYSIS problem type - .. py:method:: __post_init__() + .. py:class:: AIAgentTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the AI_AGENT problem type @@ -6145,34 +6908,39 @@ Package Contents :param agent_interface: The interface that the agent will be deployed with. :type agent_interface: AgentInterface - .. py:attribute:: description - :type: str + :type: str + .. py:attribute:: agent_interface - :type: abacusai.api_class.enums.AgentInterface + :type: abacusai.api_class.enums.AgentInterface + .. py:attribute:: enable_binary_input - :type: bool + :type: bool + .. py:attribute:: agent_input_schema - :type: dict + :type: dict + .. py:attribute:: agent_output_schema - :type: dict + :type: dict + .. py:method:: __post_init__() + .. py:class:: CustomTrainedModelTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUSTOM_TRAINED_MODEL problem type @@ -6189,56 +6957,63 @@ Package Contents :param streaming_embeddings: Flag to enable streaming embeddings. :type streaming_embeddings: bool - .. py:attribute:: max_catalog_size - :type: int + :type: int + .. py:attribute:: max_dimension - :type: int + :type: int + .. py:attribute:: index_output_path - :type: str + :type: str + .. py:attribute:: docker_image_uri - :type: str + :type: str + .. py:attribute:: service_port - :type: int + :type: int + .. py:attribute:: streaming_embeddings - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: CustomAlgorithmTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the CUSTOM_ALGORITHM problem type :param timeout_minutes: Timeout for the model training in minutes. :type timeout_minutes: int - .. py:attribute:: timeout_minutes - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: OptimizationTrainingConfig - Bases: :py:obj:`TrainingConfig` + Bases: :py:obj:`TrainingConfig` Training config for the OPTIMIZATION problem type @@ -6247,42 +7022,46 @@ Package Contents :param optimality_gap_limit: The stopping optimality gap limit. Optimality gap is fractional difference between the best known solution and the best possible solution. Accepts values between 0 and 1. :type optimality_gap_limit: float - .. py:attribute:: solve_time_limit - :type: float + :type: float + .. py:attribute:: optimality_gap_limit - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: _TrainingConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'problem_type' - + .. py:attribute:: config_class_map + + .. py:class:: DeployableAlgorithm - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Algorithm that can be deployed to a model. @@ -6295,27 +7074,31 @@ Package Contents :param trained_model_types: List of trained model types. :type trained_model_types: List[dict] - .. py:attribute:: algorithm - :type: str + :type: str + .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: only_offline_deployable - :type: bool + :type: bool + .. py:attribute:: trained_model_types - :type: List[dict] + :type: List[dict] + + .. py:class:: TimeWindowConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Time Window Configuration @@ -6324,14 +7107,15 @@ Package Contents :param window_from_start: Whether the window should be from the start of the time series. :type window_from_start: bool - .. py:attribute:: window_duration - :type: int + :type: int + .. py:attribute:: window_from_start - :type: bool + :type: bool + .. py:method:: to_dict() @@ -6343,8 +7127,8 @@ Package Contents .. py:class:: ForecastingMonitorConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Forecasting Monitor Configuration @@ -6361,30 +7145,35 @@ Package Contents :param window_config: The windowing configuration for the time series data. :type window_config: TimeWindowConfig - .. py:attribute:: id_column - :type: str + :type: str + .. py:attribute:: timestamp_column - :type: str + :type: str + .. py:attribute:: target_column - :type: str + :type: str + .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: window_config - :type: TimeWindowConfig + :type: TimeWindowConfig + .. py:method:: to_dict() @@ -6396,8 +7185,8 @@ Package Contents .. py:class:: StdDevThreshold - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Std Dev Threshold types @@ -6406,14 +7195,15 @@ Package Contents :param value: Value to use for the threshold. :type value: float - .. py:attribute:: threshold_type - :type: abacusai.api_class.enums.StdDevThresholdType + :type: abacusai.api_class.enums.StdDevThresholdType + .. py:attribute:: value - :type: float + :type: float + .. py:method:: to_dict() @@ -6425,8 +7215,8 @@ Package Contents .. py:class:: ItemAttributesStdDevThreshold - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Item Attributes Std Dev Threshold for Monitor Alerts @@ -6435,14 +7225,15 @@ Package Contents :param upper_bound: Upper bound for the item attributes. :type upper_bound: StdDevThreshold - .. py:attribute:: lower_bound - :type: StdDevThreshold + :type: StdDevThreshold + .. py:attribute:: upper_bound - :type: StdDevThreshold + :type: StdDevThreshold + .. py:method:: to_dict() @@ -6454,8 +7245,8 @@ Package Contents .. py:class:: RestrictFeatureMappings - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Restrict Feature Mappings for Monitor Filtering @@ -6472,30 +7263,35 @@ Package Contents :param max_value: Filtering the numerical feature to below this value :type max_value: float - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: restricted_feature_values - :type: list + :type: list + .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: min_value - :type: float + :type: float + .. py:attribute:: max_value - :type: float + :type: float + .. py:method:: to_dict() @@ -6507,8 +7303,8 @@ Package Contents .. py:class:: MonitorFilteringConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Monitor Filtering Configuration @@ -6525,30 +7321,35 @@ Package Contents :param prediction_target_feature: Set the target feature for the prediction data. :type prediction_target_feature: str - .. py:attribute:: start_time - :type: str + :type: str + .. py:attribute:: end_time - :type: str + :type: str + .. py:attribute:: restrict_feature_mappings - :type: List[RestrictFeatureMappings] + :type: List[RestrictFeatureMappings] + .. py:attribute:: target_class - :type: str + :type: str + .. py:attribute:: train_target_feature - :type: str + :type: str + .. py:attribute:: prediction_target_feature - :type: str + :type: str + .. py:method:: to_dict() @@ -6560,15 +7361,15 @@ Package Contents .. py:class:: AlertConditionConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for alert condition configs - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType + :type: abacusai.api_class.enums.MonitorAlertType + .. py:method:: _get_builder() :classmethod: @@ -6577,26 +7378,27 @@ Package Contents .. py:class:: AccuracyBelowThresholdConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Accuracy Below Threshold Condition Config for Monitor Alerts :param threshold: Threshold for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: FeatureDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Feature Drift Condition Config for Monitor Alerts @@ -6609,30 +7411,34 @@ Package Contents :param feature_names: List of feature names to monitor for this alert. :type feature_names: List[str] - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:attribute:: feature_names - :type: List[str] + :type: List[str] + .. py:method:: __post_init__() + .. py:class:: TargetDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Target Drift Condition Config for Monitor Alerts @@ -6641,22 +7447,24 @@ Package Contents :param threshold: Threshold for when to consider the target column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: HistoryLengthDriftConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` History Length Drift Condition Config for Monitor Alerts @@ -6665,22 +7473,24 @@ Package Contents :param threshold: Threshold for when to consider the history length to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float - .. py:attribute:: feature_drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: threshold - :type: float + :type: float + .. py:method:: __post_init__() + .. py:class:: DataIntegrityViolationConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Data Integrity Violation Condition Config for Monitor Alerts @@ -6689,22 +7499,24 @@ Package Contents :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int - .. py:attribute:: data_integrity_type - :type: abacusai.api_class.enums.DataIntegrityViolationType + :type: abacusai.api_class.enums.DataIntegrityViolationType + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: BiasViolationConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Bias Violation Condition Config for Monitor Alerts @@ -6715,26 +7527,29 @@ Package Contents :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int - .. py:attribute:: bias_type - :type: abacusai.api_class.enums.BiasType + :type: abacusai.api_class.enums.BiasType + .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: minimum_violations - :type: int + :type: int + .. py:method:: __post_init__() + .. py:class:: PredictionCountConditionConfig - Bases: :py:obj:`AlertConditionConfig` + Bases: :py:obj:`AlertConditionConfig` Deployment Prediction Condition Config for Deployment Alerts. By default we monitor if predictions made over a time window has reduced significantly. :param threshold: Threshold for when to consider to be a violation. Negative means alert on reduction, positive means alert on increase. @@ -6744,58 +7559,63 @@ Package Contents :param aggregation_type: Aggregation type to use for the aggregation window, e.g. sum, avg. :type aggregation_type: str - .. py:attribute:: threshold - :type: float + :type: float + .. py:attribute:: aggregation_window - :type: str + :type: str + .. py:attribute:: aggregation_type - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _AlertConditionConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'alert_type' - + .. py:attribute:: config_class_key_value_camel_case :value: True - + .. py:attribute:: config_class_map + + .. py:class:: AlertActionConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for alert action configs - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType + :type: abacusai.api_class.enums.AlertActionType + .. py:method:: _get_builder() :classmethod: @@ -6804,8 +7624,8 @@ Package Contents .. py:class:: EmailActionConfig - Bases: :py:obj:`AlertActionConfig` + Bases: :py:obj:`AlertActionConfig` Email Action Config for Monitor Alerts @@ -6814,42 +7634,46 @@ Package Contents :param email_body: Body of the email to send. :type email_body: str - .. py:attribute:: email_recipients - :type: List[str] + :type: List[str] + .. py:attribute:: email_body - :type: str + :type: str + .. py:method:: __post_init__() + .. py:class:: _AlertActionConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'action_type' - + .. py:attribute:: config_class_map + + .. py:class:: MonitorThresholdConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Monitor Threshold Config for Monitor Alerts @@ -6858,18 +7682,20 @@ Package Contents :param threshold_config: Thresholds for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold_config: ThresholdConfigs - .. py:attribute:: drift_type - :type: abacusai.api_class.enums.FeatureDriftType + :type: abacusai.api_class.enums.FeatureDriftType + .. py:attribute:: at_risk_threshold - :type: float + :type: float + .. py:attribute:: severely_drifting_threshold - :type: float + :type: float + .. py:method:: to_dict() @@ -6881,8 +7707,8 @@ Package Contents .. py:class:: FeatureMappingConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Feature mapping configuration for a feature group type. @@ -6893,23 +7719,26 @@ Package Contents :param nested_feature_name: The name of the nested feature in the feature group. :type nested_feature_name: str - .. py:attribute:: feature_name - :type: str + :type: str + .. py:attribute:: feature_mapping - :type: str + :type: str + .. py:attribute:: nested_feature_name - :type: str + :type: str + + .. py:class:: ProjectFeatureGroupTypeMappingsConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Project feature group type mappings. @@ -6920,18 +7749,20 @@ Package Contents :param feature_mappings: The feature mappings for the feature group. :type feature_mappings: List[FeatureMappingConfig] - .. py:attribute:: feature_group_id - :type: str + :type: str + .. py:attribute:: feature_group_type - :type: str + :type: str + .. py:attribute:: feature_mappings - :type: List[FeatureMappingConfig] + :type: List[FeatureMappingConfig] + .. py:method:: from_dict(input_dict) :classmethod: @@ -6940,8 +7771,8 @@ Package Contents .. py:class:: ConstraintConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` Constraint configuration. @@ -6956,38 +7787,43 @@ Package Contents :param penalty: The penalty for violating the constraint. :type penalty: float - .. py:attribute:: constant - :type: float + :type: float + .. py:attribute:: operator - :type: str + :type: str + .. py:attribute:: enforcement - :type: Optional[str] + :type: Optional[str] + .. py:attribute:: code - :type: Optional[str] + :type: Optional[str] + .. py:attribute:: penalty - :type: Optional[float] + :type: Optional[float] + + .. py:class:: ProjectFeatureGroupConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for project feature group configuration. - .. py:attribute:: type - :type: abacusai.api_class.enums.ProjectConfigType + :type: abacusai.api_class.enums.ProjectConfigType + .. py:method:: _get_builder() :classmethod: @@ -6996,64 +7832,68 @@ Package Contents .. py:class:: ConstraintProjectFeatureGroupConfig - Bases: :py:obj:`ProjectFeatureGroupConfig` + Bases: :py:obj:`ProjectFeatureGroupConfig` Constraint project feature group configuration. :param constraints: The constraint for the feature group. Should be a list of one ConstraintConfig. :type constraints: List[ConstraintConfig] - .. py:attribute:: constraints - :type: List[ConstraintConfig] + :type: List[ConstraintConfig] + .. py:method:: __post_init__() + .. py:class:: ReviewModeProjectFeatureGroupConfig - Bases: :py:obj:`ProjectFeatureGroupConfig` + Bases: :py:obj:`ProjectFeatureGroupConfig` Review mode project feature group configuration. :param is_review_mode: The review mode for the feature group. :type is_review_mode: bool - .. py:attribute:: is_review_mode - :type: bool + :type: bool + .. py:method:: __post_init__() + .. py:class:: _ProjectFeatureGroupConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'type' - + .. py:attribute:: config_class_map + + .. py:class:: PythonFunctionArgument - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for python function arguments @@ -7068,31 +7908,36 @@ Package Contents :param pipeline_variable: The name of the pipeline variable to use as the value :type pipeline_variable: str - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionArgumentType + :type: abacusai.api_class.enums.PythonFunctionArgumentType + .. py:attribute:: name - :type: str + :type: str + .. py:attribute:: is_required - :type: bool + :type: bool + .. py:attribute:: value - :type: Any + :type: Any + .. py:attribute:: pipeline_variable - :type: str + :type: str + + .. py:class:: OutputVariableMapping - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` A config class for python function arguments @@ -7101,26 +7946,28 @@ Package Contents :param name: The name of the python function variable :type name: str - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionOutputArgumentType + :type: abacusai.api_class.enums.PythonFunctionOutputArgumentType + .. py:attribute:: name - :type: str + :type: str + + .. py:class:: FeatureGroupExportConfig - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` + Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` An abstract class for feature group exports. - .. py:attribute:: connector_type - :type: abacusai.api_class.enums.ConnectorType + :type: abacusai.api_class.enums.ConnectorType + .. py:method:: _get_builder() :classmethod: @@ -7129,8 +7976,8 @@ Package Contents .. py:class:: FileConnectorExportConfig - Bases: :py:obj:`FeatureGroupExportConfig` + Bases: :py:obj:`FeatureGroupExportConfig` File connector export config for feature groups @@ -7139,14 +7986,15 @@ Package Contents :param export_file_format: The file format to export the feature group to :type export_file_format: str - .. py:attribute:: location - :type: str + :type: str + .. py:attribute:: export_file_format - :type: str + :type: str + .. py:method:: __post_init__() @@ -7161,8 +8009,8 @@ Package Contents .. py:class:: DatabaseConnectorExportConfig - Bases: :py:obj:`FeatureGroupExportConfig` + Bases: :py:obj:`FeatureGroupExportConfig` Database connector export config for feature groups @@ -7179,30 +8027,35 @@ Package Contents :param data_columns: The data columns to export the feature group to :type data_columns: Dict[str, str] - .. py:attribute:: database_connector_id - :type: str + :type: str + .. py:attribute:: mode - :type: str + :type: str + .. py:attribute:: object_name - :type: str + :type: str + .. py:attribute:: id_column - :type: str + :type: str + .. py:attribute:: additional_id_columns - :type: List[str] + :type: List[str] + .. py:attribute:: data_columns - :type: Dict[str, str] + :type: Dict[str, str] + .. py:method:: __post_init__() @@ -7217,33 +8070,36 @@ Package Contents .. py:class:: _FeatureGroupExportConfigFactory - Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` + Bases: :py:obj:`abacusai.api_class.abstract._ApiClassFactory` Helper class that provides a standard way to create an ABC using inheritance. - .. py:attribute:: config_abstract_class + .. py:attribute:: config_class_key :value: 'connector_type' - + .. py:attribute:: config_class_map + + .. py:class:: AgentResponse(*args, **kwargs) + Response object for agent to support attachments, section data and normal data .. py:class:: ApiClient(api_key = None, server = None, client_options = None, skip_version_check = False) - Bases: :py:obj:`ReadOnlyClient` + Bases: :py:obj:`ReadOnlyClient` Abacus.AI API Client @@ -7256,7 +8112,6 @@ Package Contents :param skip_version_check: If true, will skip checking the server's current API version on initializing the client :type skip_version_check: bool - .. py:method:: create_dataset_from_pandas(feature_group_table_name, df, clean_column_names = False) [Deprecated] @@ -7273,7 +8128,6 @@ Package Contents :rtype: Dataset - .. py:method:: create_dataset_version_from_pandas(table_name_or_id, df, clean_column_names = False) [Deprecated] @@ -7290,7 +8144,6 @@ Package Contents :rtype: Dataset - .. py:method:: create_feature_group_from_pandas_df(table_name, df, clean_column_names = False) Create a Feature Group from a local Pandas DataFrame. @@ -7303,7 +8156,6 @@ Package Contents :type clean_column_names: bool - .. py:method:: update_feature_group_from_pandas_df(table_name, df, clean_column_names = False) Updates a DATASET Feature Group from a local Pandas DataFrame. @@ -7316,7 +8168,6 @@ Package Contents :type clean_column_names: bool - .. py:method:: create_feature_group_from_spark_df(table_name, df) Create a Feature Group from a local Spark DataFrame. @@ -7327,7 +8178,6 @@ Package Contents :type table_name: str - .. py:method:: update_feature_group_from_spark_df(table_name, df) Create a Feature Group from a local Spark DataFrame. @@ -7342,7 +8192,6 @@ Package Contents :type timeout: int - .. py:method:: create_spark_df_from_feature_group_version(session, feature_group_version) Create a Spark Dataframe in the provided Spark Session context, for a materialized Abacus Feature Group Version. @@ -7355,7 +8204,6 @@ Package Contents :returns: pyspark.sql.DataFrame - .. py:method:: create_prediction_operator_from_functions(name, project_id, predict_function = None, initialize_function = None, feature_group_ids = None, cpu_size = None, memory = None, included_modules = None, package_requirements = None, use_gpu = False) Create a new prediction operator. @@ -7385,7 +8233,6 @@ Package Contents PredictionOperator: The updated prediction operator object. - .. py:method:: update_prediction_operator_from_functions(prediction_operator_id, name = None, predict_function = None, initialize_function = None, feature_group_ids = None, cpu_size = None, memory = None, included_modules = None, package_requirements = None, use_gpu = False) Update an existing prediction operator. @@ -7412,7 +8259,6 @@ Package Contents :type use_gpu: bool - .. py:method:: create_model_from_functions(project_id, train_function, predict_function = None, training_input_tables = None, predict_many_function = None, initialize_function = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False, included_modules = None, package_requirements = None, name = None, use_gpu = False, is_thread_safe = None) Creates a model from a python function @@ -7449,7 +8295,6 @@ Package Contents :type is_thread_safe: bool - .. py:method:: update_model_from_functions(model_id, train_function, predict_function = None, predict_many_function = None, initialize_function = None, training_input_tables = None, cpu_size = None, memory = None, included_modules = None, package_requirements = None, use_gpu = False, is_thread_safe = None) Creates a model from a python function. Please pass in all the functions, even if you don't update it. @@ -7480,7 +8325,6 @@ Package Contents :type is_thread_safe: bool - .. py:method:: create_pipeline_step_from_function(pipeline_id, step_name, function, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, included_modules = None, timeout = None) Creates a step in a given pipeline from a python function. @@ -7509,7 +8353,6 @@ Package Contents :type timeout: int - .. py:method:: update_pipeline_step_from_function(pipeline_step_id, function, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, included_modules = None, timeout = None) Updates a pipeline step from a python function. @@ -7536,7 +8379,6 @@ Package Contents :type timeout: int - .. py:method:: create_python_function_from_function(name, function, function_variable_mappings = None, package_requirements = None, function_type = PythonFunctionType.FEATURE_GROUP.value) Creates a custom Python function @@ -7553,7 +8395,6 @@ Package Contents :type function_type: PythonFunctionType - .. py:method:: create_feature_group_from_python_function(function, table_name, input_tables = None, python_function_name = None, python_function_bindings = None, cpu_size = None, memory = None, package_requirements = None, included_modules = None) Creates a feature group from a python function @@ -7578,7 +8419,6 @@ Package Contents :type included_modules: list - .. py:method:: update_python_function_code(name, function = None, function_variable_mappings = None, package_requirements = None, included_modules = None) Update custom python function with user inputs for the given python function. @@ -7598,7 +8438,6 @@ Package Contents :rtype: PythonFunction - .. py:method:: create_algorithm_from_function(name, problem_type, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function = None, predict_function = None, predict_many_function = None, initialize_function = None, common_functions = None, config_options = None, is_default_enabled = False, project_id = None, use_gpu = False, package_requirements = None, included_modules = None) Create a new algorithm, or update existing algorithm if the name already exists @@ -7635,7 +8474,6 @@ Package Contents :type included_modules: list - .. py:method:: update_algorithm_from_function(algorithm, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function = None, predict_function = None, predict_many_function = None, initialize_function = None, common_functions = None, config_options = None, is_default_enabled = None, use_gpu = None, package_requirements = None, included_modules = None) Create a new algorithm, or update existing algorithm if the name already exists @@ -7668,7 +8506,6 @@ Package Contents :type included_modules: list - .. py:method:: get_train_function_input(project_id, training_table_names = None, training_data_parameter_name_override = None, training_config_parameter_name_override = None, training_config = None, custom_algorithm_config = None) Get the input data for the train function to test locally. @@ -7689,7 +8526,6 @@ Package Contents :returns: A dictionary that maps train function parameter names to their values. - .. py:method:: get_train_function_input_from_model_version(model_version, algorithm = None, training_config = None, custom_algorithm_config = None) Get the input data for the train function to test locally, based on a trained model version. @@ -7706,7 +8542,6 @@ Package Contents :returns: A dictionary that maps train function parameter names to their values. - .. py:method:: create_custom_loss_function(name, loss_function_type, loss_function) Registers a new custom loss function which can be used as an objective function during model training. @@ -7725,7 +8560,6 @@ Package Contents :raises AlreadyExistsError: If the loss function with the same name already exists in the organization - .. py:method:: update_custom_loss_function(name, loss_function) Updates a previously registered custom loss function with a new function implementation. @@ -7742,7 +8576,6 @@ Package Contents :raises DataNotFoundError: If a loss function with given name is not found in the organization - .. py:method:: create_custom_metric_from_function(name, problem_type, custom_metric_function) Registers a new custom metric which can be used as an evaluation metric for the trained model. @@ -7761,7 +8594,6 @@ Package Contents :raises AlreadyExistsError: If a custom metric with given name already exists in the organization. - .. py:method:: update_custom_metric_from_function(name, custom_metric_function) Updates a previously registered custom metric. @@ -7778,7 +8610,6 @@ Package Contents :raises DataNotFoundError: If a custom metric with given name is not found in the organization. - .. py:method:: create_module_from_notebook(file_path, name) Create a module with the code marked in the notebook. Use '#module_start#' to mark the starting code cell and '#module_end#' for the @@ -7793,7 +8624,6 @@ Package Contents :rtype: Module - .. py:method:: update_module_from_notebook(file_path, name) Update the module with the code marked in the notebook. Use '#module_start#' to mark the starting code cell and '#module_end#' for the @@ -7808,7 +8638,6 @@ Package Contents :rtype: Module - .. py:method:: import_module(name) Import a module created previously. It will reload if has been imported before. @@ -7821,7 +8650,6 @@ Package Contents :rtype: module - .. py:method:: create_agent_from_function(project_id, agent_function, name = None, memory = None, package_requirements = None, description = None, evaluation_feature_group_id = None, workflow_graph = None) [Deprecated] @@ -7845,7 +8673,6 @@ Package Contents :type workflow_graph: WorkflowGraph - .. py:method:: update_agent_with_function(model_id, agent_function, memory = None, package_requirements = None, enable_binary_input = None, description = None, workflow_graph = None) [Deprecated] @@ -7867,7 +8694,6 @@ Package Contents :type workflow_graph: WorkflowGraph - .. py:method:: execute_feature_group_sql(sql, fix_query_on_error = False, timeout=3600, delay=2) Execute a SQL query on the feature groups @@ -7881,14 +8707,13 @@ Package Contents :rtype: pandas.DataFrame - .. py:method:: get_agent_context_chat_history() Gets a history of chat messages from the current request context. Applicable within a AIAgent execute function. - :returns: List[ChatMessage]:: The chat history for the current request being processed by the Agent. - + :returns: The chat history for the current request being processed by the Agent. + :rtype: List[ChatMessage] .. py:method:: set_agent_context_chat_history(chat_history) @@ -7899,7 +8724,6 @@ Package Contents :type chat_history: List[ChatMessage] - .. py:method:: get_agent_context_conversation_id() Gets the deployment conversation ID from the current request context. Applicable within a AIAgent @@ -7909,7 +8733,6 @@ Package Contents :rtype: str - .. py:method:: set_agent_context_conversation_id(conversation_id) Sets the deployment conversation ID from the current request context. @@ -7918,7 +8741,6 @@ Package Contents :type conversation_id: str - .. py:method:: get_agent_context_external_session_id() Gets the external session ID from the current request context if it has been set with the request. @@ -7928,7 +8750,6 @@ Package Contents :rtype: str - .. py:method:: set_agent_context_external_session_id(external_session_id) Sets the external session ID from the current request context if it has been set with the request. @@ -7937,7 +8758,6 @@ Package Contents :type external_session_id: str - .. py:method:: get_agent_context_doc_ids() Gets the document ID from the current request context if a document has been uploaded with the request. @@ -7947,7 +8767,6 @@ Package Contents :rtype: List[str] - .. py:method:: set_agent_context_doc_ids(doc_ids) Sets the doc_ids from the current request context. @@ -7956,7 +8775,6 @@ Package Contents :type doc_ids: List[str] - .. py:method:: get_agent_context_doc_infos() Gets the document information from the current request context if documents have been uploaded with the request. @@ -7966,7 +8784,6 @@ Package Contents :rtype: List[dict] - .. py:method:: set_agent_context_doc_infos(doc_infos) Sets the doc_infos in the current request context. @@ -7975,7 +8792,6 @@ Package Contents :type doc_infos: List[dict] - .. py:method:: get_agent_context_blob_inputs() Gets the BlobInputs from the current request context if a document has been uploaded with the request. @@ -7985,13 +8801,11 @@ Package Contents :rtype: List[BlobInput] - .. py:method:: clear_agent_context() Clears the current request context. - .. py:method:: streaming_evaluate_prompt(prompt = None, system_message = None, llm_name = None, max_tokens = None, temperature = 0.0, messages = None, response_type = None, json_response_schema = None, section_key = None) Generate response to the prompt using the specified model. @@ -8017,8 +8831,7 @@ Package Contents :type section_key: str :returns: The response from the model. - :rtype: text - + :rtype: text (str) .. py:method:: _get_agent_app_request_id() @@ -8029,7 +8842,6 @@ Package Contents :rtype: str - .. py:method:: _get_agent_async_app_caller() Gets the caller for the current request context of async app. Applicable within a AIAgent execute function. @@ -8038,7 +8850,6 @@ Package Contents :rtype: str - .. py:method:: _is_proxy_app_caller() Gets the caller for the current request context of async app. Applicable within a AIAgent execute function. @@ -8047,7 +8858,6 @@ Package Contents :rtype: bool - .. py:method:: stream_message(message) Streams a message to the current request context. Applicable within a AIAgent execute function. @@ -8057,7 +8867,6 @@ Package Contents :type message: str - .. py:method:: stream_section_output(section_key, value, value_type = 'text') Streams value corresponding to a particular section to the current request context. Applicable within a AIAgent execute function. @@ -8071,7 +8880,6 @@ Package Contents :type value_type: str - .. py:method:: _stream_llm_call(section_key=None, **kwargs) @@ -8092,7 +8900,6 @@ Package Contents :rtype: str - .. py:method:: _status_poll(url, wait_states, method, body = {}, headers = None, delay = 2, timeout = 1200) @@ -8123,7 +8930,6 @@ Package Contents :rtype: LlmExecutionResult - .. py:method:: _get_doc_retriever_deployment_info(document_retriever_id) @@ -8167,7 +8973,6 @@ Package Contents :rtype: list[DocumentRetrieverLookupResult] - .. py:method:: create_model_from_files(project_id, location, name = None, custom_artifact_filenames = {}, model_config = {}) Creates a new Model and returns Upload IDs for uploading the model artifacts. @@ -8190,7 +8995,6 @@ Package Contents :rtype: Model - .. py:method:: create_model_from_local_files(project_id, name = None, optional_artifacts = None, model_config = {}) Creates a new Model and returns Upload IDs for uploading the model artifacts. @@ -8211,7 +9015,6 @@ Package Contents :rtype: ModelUpload - .. py:method:: create_model_version_from_files(model_id) Creates a new Model Version by re-importing from the paths specified when the model was created. @@ -8223,7 +9026,6 @@ Package Contents :rtype: ModelVersion - .. py:method:: create_model_version_from_local_files(model_id, optional_artifacts = None) Creates a new Model Version and returns Upload IDs for uploading the associated model artifacts. @@ -8237,7 +9039,6 @@ Package Contents :rtype: ModelUpload - .. py:method:: get_streaming_chat_response(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, include_search_results = False) Return an asynchronous generator which continues the conversation based on the input messages and search results. @@ -8268,7 +9069,6 @@ Package Contents :type include_search_results: bool - .. py:method:: get_streaming_conversation_response(deployment_token, deployment_id, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, include_search_results = False) Return an asynchronous generator which continues the conversation based on the input messages and search results. @@ -8303,7 +9103,6 @@ Package Contents :type include_search_results: bool - .. py:method:: set_cache_scope(scope) Set the scope of the cache, for example, deployment id. @@ -8314,13 +9113,11 @@ Package Contents :returns: None - .. py:method:: clear_cache_scope() Clear the scope set before, and let it to automatically figure out the scope to use. If nothing found, will run in local. - .. py:method:: set_scoped_cache_value(key, value, expiration_time = 21600) Set the value to key in the cache scope. Scope will be automatically figured out inside a deployment, or set with set_cache_scope. @@ -8338,7 +9135,6 @@ Package Contents :raises InvalidParameterError: If key, value or expiration_time is invalid. - .. py:method:: get_scoped_cache_value(key) Get the value of the key in the cache scope. Scope will be automatically figured out inside a deployment, or set with set_cache_scope. @@ -8353,7 +9149,6 @@ Package Contents :raises Generic404Error: if the key doesn't exist. - .. py:method:: delete_scoped_cache_key(key) Delete the value of the key in the cache scope. Scope will be automatically figured out inside a deployment, or set with set_cache_scope. @@ -8365,7 +9160,6 @@ Package Contents :returns: None - .. py:method:: add_user_to_organization(email) Invite a user to your organization. This method will send the specified email address an invitation link to join your organization. @@ -8374,7 +9168,6 @@ Package Contents :type email: str - .. py:method:: create_organization_group(group_name, permissions, default_group = False) Creates a new Organization Group. @@ -8390,7 +9183,6 @@ Package Contents :rtype: OrganizationGroup - .. py:method:: add_organization_group_permission(organization_group_id, permission) Adds a permission to the specified Organization Group. @@ -8401,7 +9193,6 @@ Package Contents :type permission: str - .. py:method:: remove_organization_group_permission(organization_group_id, permission) Removes a permission from the specified Organization Group. @@ -8412,7 +9203,6 @@ Package Contents :type permission: str - .. py:method:: delete_organization_group(organization_group_id) Deletes the specified Organization Group @@ -8421,7 +9211,6 @@ Package Contents :type organization_group_id: str - .. py:method:: add_user_to_organization_group(organization_group_id, email) Adds a user to the specified Organization Group. @@ -8432,7 +9221,6 @@ Package Contents :type email: str - .. py:method:: remove_user_from_organization_group(organization_group_id, email) Removes a user from an Organization Group. @@ -8443,7 +9231,6 @@ Package Contents :type email: str - .. py:method:: set_default_organization_group(organization_group_id) Sets the default Organization Group to which all new users joining an organization are automatically added. @@ -8452,7 +9239,6 @@ Package Contents :type organization_group_id: str - .. py:method:: delete_api_key(api_key_id) Delete a specified API key. @@ -8461,7 +9247,6 @@ Package Contents :type api_key_id: str - .. py:method:: remove_user_from_organization(email) Removes the specified user from the organization. You can remove yourself; otherwise, you must be an organization administrator to use this method to remove other users from the organization. @@ -8470,7 +9255,6 @@ Package Contents :type email: str - .. py:method:: send_email(email, subject, body, is_html = False) Send an email to the specified email address with provided subject and contents. @@ -8485,7 +9269,6 @@ Package Contents :type is_html: bool - .. py:method:: create_deployment_webhook(deployment_id, endpoint, webhook_event_type, payload_template = None) Create a webhook attached to a given deployment ID. @@ -8503,7 +9286,6 @@ Package Contents :rtype: Webhook - .. py:method:: update_webhook(webhook_id, endpoint = None, webhook_event_type = None, payload_template = None) Update the webhook @@ -8518,7 +9300,6 @@ Package Contents :type payload_template: dict - .. py:method:: delete_webhook(webhook_id) Delete the webhook @@ -8527,7 +9308,6 @@ Package Contents :type webhook_id: str - .. py:method:: create_project(name, use_case) Creates a project with the specified project name and use case. Creating a project creates a container for all datasets and models associated with a particular problem/project. For example, if you want to create a model to detect fraud, you need to first create a project, upload datasets, create feature groups, and then create one or more models to get predictions for your use case. @@ -8541,7 +9321,6 @@ Package Contents :rtype: Project - .. py:method:: rename_project(project_id, name) This method renames a project after it is created. @@ -8552,7 +9331,6 @@ Package Contents :type name: str - .. py:method:: delete_project(project_id) Delete a specified project from your organization. @@ -8568,7 +9346,6 @@ Package Contents :type project_id: str - .. py:method:: add_project_tags(project_id, tags) This method adds a tag to a project. @@ -8579,7 +9356,6 @@ Package Contents :type tags: list - .. py:method:: remove_project_tags(project_id, tags) This method removes a tag from a project. @@ -8590,7 +9366,6 @@ Package Contents :type tags: list - .. py:method:: add_feature_group_to_project(feature_group_id, project_id, feature_group_type = 'CUSTOM_TABLE') Adds a feature group to a project. @@ -8603,7 +9378,6 @@ Package Contents :type feature_group_type: str - .. py:method:: set_project_feature_group_config(feature_group_id, project_id, project_config = None) Sets a feature group's project config @@ -8616,7 +9390,6 @@ Package Contents :type project_config: ProjectFeatureGroupConfig - .. py:method:: remove_feature_group_from_project(feature_group_id, project_id) Removes a feature group from a project. @@ -8627,7 +9400,6 @@ Package Contents :type project_id: str - .. py:method:: set_feature_group_type(feature_group_id, project_id, feature_group_type = 'CUSTOM_TABLE') Update the feature group type in a project. The feature group must already be added to the project. @@ -8640,7 +9412,6 @@ Package Contents :type feature_group_type: str - .. py:method:: set_feature_mapping(project_id, feature_group_id, feature_name, feature_mapping = None, nested_column_name = None) Set a column's feature mapping. If the column mapping is single-use and already set in another column in this feature group, this call will first remove the other column's mapping and move it to this column. @@ -8660,7 +9431,6 @@ Package Contents :rtype: list[Feature] - .. py:method:: add_annotation(annotation, feature_group_id, feature_name, doc_id = None, feature_group_row_identifier = None, annotation_source = 'ui', status = None, comments = None, project_id = None, save_metadata = False, pages = None) Add an annotation entry to the database. @@ -8692,7 +9462,6 @@ Package Contents :rtype: AnnotationEntry - .. py:method:: describe_annotation(feature_group_id, feature_name = None, doc_id = None, feature_group_row_identifier = None) Get the latest annotation entry for a given feature group, feature, and document. @@ -8710,7 +9479,6 @@ Package Contents :rtype: AnnotationEntry - .. py:method:: update_annotation_status(feature_group_id, feature_name, status, doc_id = None, feature_group_row_identifier = None, save_metadata = False) Update the status of an annotation entry. @@ -8732,7 +9500,6 @@ Package Contents :rtype: AnnotationEntry - .. py:method:: get_document_to_annotate(feature_group_id, project_id, feature_name, feature_group_row_identifier = None, get_previous = False) Get an available document that needs to be annotated for a annotation feature group. @@ -8752,7 +9519,6 @@ Package Contents :rtype: AnnotationDocument - .. py:method:: import_annotation_labels(feature_group_id, file, annotation_type) Imports annotation labels from csv file. All valid values in the file will be imported as labels (including header row if present). @@ -8768,7 +9534,6 @@ Package Contents :rtype: AnnotationConfig - .. py:method:: create_feature_group(table_name, sql, description = None) Creates a new FeatureGroup from a SQL statement. @@ -8784,7 +9549,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_feature_group_from_template(table_name, feature_group_template_id, template_bindings = None, should_attach_feature_group_to_template = True, description = None) Creates a new feature group from a SQL statement. @@ -8804,7 +9568,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_feature_group_from_function(table_name, function_source_code = None, function_name = None, input_feature_groups = None, description = None, cpu_size = None, memory = None, package_requirements = None, use_original_csv_names = False, python_function_name = None, python_function_bindings = None, use_gpu = None) Creates a new feature in a Feature Group from user-provided code. Currently supported code languages are Python. @@ -8825,9 +9588,9 @@ Package Contents :param description: The description for this feature group. :type description: str :param cpu_size: Size of the CPU for the feature group function. - :type cpu_size: str + :type cpu_size: CPUSize :param memory: Memory (in GB) for the feature group function. - :type memory: int + :type memory: MemorySize :param package_requirements: List of package requirements for the feature group function. For example: ['numpy==1.2.3', 'pandas>=1.4.0'] :type package_requirements: list :param use_original_csv_names: Defaults to False, if set it uses the original column names for input feature groups from CSV datasets. @@ -8843,7 +9606,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_sampling_feature_group(feature_group_id, table_name, sampling_config, description = None) Creates a new Feature Group defined as a sample of rows from another Feature Group. @@ -8864,7 +9626,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_merge_feature_group(source_feature_group_id, table_name, merge_config, description = None) Creates a new feature group defined as the union of other feature group versions. @@ -8881,7 +9642,6 @@ Package Contents Creates a new feature group defined as the union of other feature group versions. - .. py:method:: create_operator_feature_group(source_feature_group_id, table_name, operator_config, description = None) Creates a new Feature Group defined by a pre-defined operator applied to another Feature Group. @@ -8890,8 +9650,8 @@ Package Contents :type source_feature_group_id: str :param table_name: Unique string identifier for the operator Feature Group. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. :type table_name: str - :param operator_config: JSON object (aka map) defining the operator and its parameters. - :type operator_config: dict + :param operator_config: The operator config is used to define the operator and its parameters. + :type operator_config: OperatorConfig :param description: Human-readable description of the Feature Group. :type description: str @@ -8899,7 +9659,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_snapshot_feature_group(feature_group_version, table_name) Creates a Snapshot Feature Group corresponding to a specific Feature Group version. @@ -8913,7 +9672,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_online_feature_group(table_name, primary_key, description = None) Creates an Online Feature Group. @@ -8929,7 +9687,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_feature_group_sampling_config(feature_group_id, sampling_config) Set a FeatureGroup’s sampling to the config values provided, so that the rows the FeatureGroup returns will be a sample of those it would otherwise have returned. @@ -8943,7 +9700,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_feature_group_merge_config(feature_group_id, merge_config) Set a MergeFeatureGroup’s merge config to the values provided, so that the feature group only returns a bounded range of an incremental dataset. @@ -8957,7 +9713,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_feature_group_operator_config(feature_group_id, operator_config) Set a OperatorFeatureGroup’s operator config to the values provided. @@ -8965,8 +9720,10 @@ Package Contents :param feature_group_id: A unique string identifier associated with the feature group. :type feature_group_id: str :param operator_config: A dictionary object specifying the pre-defined operations. - :type operator_config: dict + :type operator_config: OperatorConfig + :returns: The updated FeatureGroup. + :rtype: FeatureGroup .. py:method:: set_feature_group_schema(feature_group_id, schema) @@ -8979,7 +9736,6 @@ Package Contents :type schema: list - .. py:method:: create_feature(feature_group_id, name, select_expression) Creates a new feature in a Feature Group from a SQL select statement. @@ -8995,7 +9751,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: add_feature_group_tag(feature_group_id, tag) Adds a tag to the feature group @@ -9006,7 +9761,6 @@ Package Contents :type tag: str - .. py:method:: remove_feature_group_tag(feature_group_id, tag) Removes a tag from the specified feature group. @@ -9017,7 +9771,6 @@ Package Contents :type tag: str - .. py:method:: add_annotatable_feature(feature_group_id, name, annotation_type) Add an annotatable feature in a Feature Group @@ -9033,7 +9786,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_feature_as_annotatable_feature(feature_group_id, feature_name, annotation_type, feature_group_row_identifier_feature = None, doc_id_feature = None) Sets an existing feature as an annotatable feature (Feature that can be annotated). @@ -9053,7 +9805,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_annotation_status_feature(feature_group_id, feature_name) Sets a feature as the annotation status feature for a feature group. @@ -9067,7 +9818,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: unset_feature_as_annotatable_feature(feature_group_id, feature_name) Unsets a feature as annotatable @@ -9081,7 +9831,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: add_feature_group_annotation_label(feature_group_id, label_name, annotation_type, label_definition = None) Adds an annotation label @@ -9099,7 +9848,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: remove_feature_group_annotation_label(feature_group_id, label_name) Removes an annotation label @@ -9113,7 +9861,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: add_feature_tag(feature_group_id, feature, tag) Adds a tag on a feature @@ -9126,7 +9873,6 @@ Package Contents :type tag: str - .. py:method:: remove_feature_tag(feature_group_id, feature, tag) Removes a tag from a feature @@ -9139,7 +9885,6 @@ Package Contents :type tag: str - .. py:method:: create_nested_feature(feature_group_id, nested_feature_name, table_name, using_clause, where_clause = None, order_clause = None) Creates a new nested feature in a feature group from a SQL statement. @@ -9161,7 +9906,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_nested_feature(feature_group_id, nested_feature_name, table_name = None, using_clause = None, where_clause = None, order_clause = None, new_nested_feature_name = None) Updates a previously existing nested feature in a feature group. @@ -9185,7 +9929,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: delete_nested_feature(feature_group_id, nested_feature_name) Delete a nested feature. @@ -9199,7 +9942,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_feature(feature_group_id, feature_name, history_table_name, aggregation_keys, timestamp_key, historical_timestamp_key, expression, lookback_window_seconds = None, lookback_window_lag_seconds = 0, lookback_count = None, lookback_until_position = 0) Creates a new point in time feature in a feature group using another historical feature group, window spec, and aggregate expression. @@ -9236,7 +9978,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_feature(feature_group_id, feature_name, history_table_name = None, aggregation_keys = None, timestamp_key = None, historical_timestamp_key = None, expression = None, lookback_window_seconds = None, lookback_window_lag_seconds = None, lookback_count = None, lookback_until_position = None, new_feature_name = None) Updates an existing Point-in-Time (PiT) feature in a feature group. See `createPointInTimeFeature` for detailed semantics. @@ -9270,7 +10011,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_group(feature_group_id, group_name, window_key, aggregation_keys, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = 0, lookback_count = None, lookback_until_position = 0) Create a Point-in-Time Group @@ -9302,7 +10042,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: generate_point_in_time_features(feature_group_id, group_name, columns, window_functions, prefix = None) Generates and adds PIT features given the selected columns to aggregate over, and the operations to include. @@ -9322,7 +10061,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_group(feature_group_id, group_name, window_key = None, aggregation_keys = None, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = None, lookback_count = None, lookback_until_position = None) Update Point-in-Time Group @@ -9354,7 +10092,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: delete_point_in_time_group(feature_group_id, group_name) Delete point in time group @@ -9368,7 +10105,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: create_point_in_time_group_feature(feature_group_id, group_name, name, expression) Create point in time group feature @@ -9386,7 +10122,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_point_in_time_group_feature(feature_group_id, group_name, name, expression) Update a feature's SQL expression in a point in time group @@ -9404,7 +10139,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_feature_type(feature_group_id, feature, feature_type, project_id = None) Set the type of a feature in a feature group. Specify the feature group ID, feature name, and feature type, and the method will return the new column with the changes reflected. @@ -9422,7 +10156,6 @@ Package Contents :rtype: Schema - .. py:method:: invalidate_streaming_feature_group_data(feature_group_id, invalid_before_timestamp) Invalidates all streaming data with timestamp before invalidBeforeTimestamp @@ -9433,7 +10166,6 @@ Package Contents :type invalid_before_timestamp: int - .. py:method:: concatenate_feature_group_data(feature_group_id, source_feature_group_id, merge_type = 'UNION', replace_until_timestamp = None, skip_materialize = False) Concatenates data from one Feature Group to another. Feature Groups can be merged if their schemas are compatible, they have the special `updateTimestampKey` column, and (if set) the `primaryKey` column. The second operand in the concatenate operation will be appended to the first operand (merge target). @@ -9450,7 +10182,6 @@ Package Contents :type skip_materialize: bool - .. py:method:: remove_concatenation_config(feature_group_id) Removes the concatenation config on a destination feature group. @@ -9459,7 +10190,6 @@ Package Contents :type feature_group_id: str - .. py:method:: set_feature_group_indexing_config(feature_group_id, primary_key = None, update_timestamp_key = None, lookup_keys = None) Sets various attributes of the feature group used for primary key, deployment lookups and streaming updates. @@ -9474,7 +10204,6 @@ Package Contents :type lookup_keys: list - .. py:method:: execute_async_feature_group_operation(query = None, fix_query_on_error = False) Starts the execution of fg operation @@ -9488,7 +10217,6 @@ Package Contents :rtype: ExecuteFeatureGroupOperation - .. py:method:: describe_async_feature_group_operation(feature_group_operation_run_id) Gets the status of the execution of fg operation @@ -9500,7 +10228,6 @@ Package Contents :rtype: ExecuteFeatureGroupOperation - .. py:method:: update_feature_group(feature_group_id, description = None) Modify an existing Feature Group. @@ -9514,7 +10241,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: detach_feature_group_from_template(feature_group_id) Update a feature group to detach it from a template. @@ -9526,7 +10252,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_feature_group_template_bindings(feature_group_id, template_bindings = None) Update the feature group template bindings for a template feature group. @@ -9540,7 +10265,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_feature_group_python_function_bindings(feature_group_id, python_function_bindings) Updates an existing Feature Group's Python function bindings from a user-provided Python Function. If a list of feature groups are supplied within the Python function bindings, we will provide DataFrames (Pandas in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. @@ -9551,7 +10275,6 @@ Package Contents :type python_function_bindings: List - .. py:method:: update_feature_group_python_function(feature_group_id, python_function_name, python_function_bindings = None, cpu_size = None, memory = None, use_gpu = None, use_original_csv_names = None) Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function @@ -9567,16 +10290,15 @@ Package Contents :param python_function_bindings: List of python function arguments. :type python_function_bindings: List :param cpu_size: Size of the CPU for the feature group python function. - :type cpu_size: str + :type cpu_size: CPUSize :param memory: Memory (in GB) for the feature group python function. - :type memory: int + :type memory: MemorySize :param use_gpu: Whether the feature group needs a gpu or not. Otherwise default to CPU. :type use_gpu: bool :param use_original_csv_names: If enabled, it uses the original column names for input feature groups from CSV datasets. :type use_original_csv_names: bool - .. py:method:: update_feature_group_sql_definition(feature_group_id, sql) Updates the SQL statement for a feature group. @@ -9590,7 +10312,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_dataset_feature_group_feature_expression(feature_group_id, feature_expression) Updates the SQL feature expression for a Dataset FeatureGroup's custom features @@ -9604,7 +10325,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: update_feature(feature_group_id, name, select_expression = None, new_name = None) Modifies an existing feature in a feature group. @@ -9622,7 +10342,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: export_feature_group_version_to_file_connector(feature_group_version, location, export_file_format, overwrite = False) Export Feature group to File Connector. @@ -9640,7 +10359,6 @@ Package Contents :rtype: FeatureGroupExport - .. py:method:: export_feature_group_version_to_database_connector(feature_group_version, database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) Export Feature group to Database Connector. @@ -9664,7 +10382,6 @@ Package Contents :rtype: FeatureGroupExport - .. py:method:: export_feature_group_version_to_console(feature_group_version, export_file_format) Export Feature group to console. @@ -9678,7 +10395,6 @@ Package Contents :rtype: FeatureGroupExport - .. py:method:: set_feature_group_modifier_lock(feature_group_id, locked = True) Lock a feature group to prevent modification. @@ -9689,7 +10405,6 @@ Package Contents :type locked: bool - .. py:method:: add_user_to_feature_group_modifiers(feature_group_id, email) Adds a user to a feature group. @@ -9700,7 +10415,6 @@ Package Contents :type email: str - .. py:method:: add_organization_group_to_feature_group_modifiers(feature_group_id, organization_group_id) Add OrganizationGroup to a feature group modifiers list @@ -9711,7 +10425,6 @@ Package Contents :type organization_group_id: str - .. py:method:: remove_user_from_feature_group_modifiers(feature_group_id, email) Removes a user from a specified feature group. @@ -9722,7 +10435,6 @@ Package Contents :type email: str - .. py:method:: remove_organization_group_from_feature_group_modifiers(feature_group_id, organization_group_id) Removes an OrganizationGroup from a feature group modifiers list @@ -9733,7 +10445,6 @@ Package Contents :type organization_group_id: str - .. py:method:: delete_feature(feature_group_id, name) Removes a feature from the feature group. @@ -9747,7 +10458,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: delete_feature_group(feature_group_id) Deletes a Feature Group. @@ -9756,7 +10466,6 @@ Package Contents :type feature_group_id: str - .. py:method:: create_feature_group_version(feature_group_id, variable_bindings = None) Creates a snapshot for a specified feature group. Triggers materialization of the feature group. The new version of the feature group is created after it has materialized. @@ -9770,7 +10479,6 @@ Package Contents :rtype: FeatureGroupVersion - .. py:method:: create_feature_group_template(feature_group_id, name, template_sql, template_variables, description = None, template_bindings = None, should_attach_feature_group_to_template = False) Create a feature group template. @@ -9794,7 +10502,6 @@ Package Contents :rtype: FeatureGroupTemplate - .. py:method:: delete_feature_group_template(feature_group_template_id) Delete an existing feature group template. @@ -9803,7 +10510,6 @@ Package Contents :type feature_group_template_id: str - .. py:method:: update_feature_group_template(feature_group_template_id, template_sql = None, template_variables = None, description = None, name = None) Update a feature group template. @@ -9823,7 +10529,6 @@ Package Contents :rtype: FeatureGroupTemplate - .. py:method:: preview_feature_group_template_resolution(feature_group_template_id = None, template_bindings = None, template_sql = None, template_variables = None, should_validate = True) Resolve template sql using template variables and template bindings. @@ -9843,7 +10548,6 @@ Package Contents :rtype: ResolvedFeatureGroupTemplate - .. py:method:: cancel_upload(upload_id) Cancels an upload. @@ -9852,7 +10556,6 @@ Package Contents :type upload_id: str - .. py:method:: upload_part(upload_id, part_number, part_data) Uploads part of a large dataset file from your bucket to our system. Our system currently supports parts of up to 5GB and full files of up to 5TB. Note that each part must be at least 5MB in size, unless it is the last part in the sequence of parts for the full file. @@ -9868,7 +10571,6 @@ Package Contents :rtype: UploadPart - .. py:method:: mark_upload_complete(upload_id) Marks an upload process as complete. @@ -9880,7 +10582,6 @@ Package Contents :rtype: Upload - .. py:method:: create_dataset_from_file_connector(table_name, location, file_format = None, refresh_schedule = None, csv_delimiter = None, filename_column = None, start_prefix = None, until_prefix = None, location_date_format = None, date_format_lookback_days = None, incremental = False, is_documentset = False, extract_bounding_boxes = False, document_processing_config = None, merge_file_schemas = False, reference_only_documentset = False, parsing_config = None) Creates a dataset from a file located in a cloud storage, such as Amazon AWS S3, using the specified dataset name and location. @@ -9924,7 +10625,6 @@ Package Contents :rtype: Dataset - .. py:method:: create_dataset_version_from_file_connector(dataset_id, location = None, file_format = None, csv_delimiter = None, merge_file_schemas = None, parsing_config = None) Creates a new version of the specified dataset. @@ -9946,7 +10646,6 @@ Package Contents :rtype: DatasetVersion - .. py:method:: create_dataset_from_database_connector(table_name, database_connector_id, object_name = None, columns = None, query_arguments = None, refresh_schedule = None, sql_query = None, incremental = False, incremental_database_connector_config = None) Creates a dataset from a Database Connector. @@ -9974,7 +10673,6 @@ Package Contents :rtype: Dataset - .. py:method:: create_dataset_from_application_connector(table_name, application_connector_id, dataset_config = None, refresh_schedule = None) Creates a dataset from an Application Connector. @@ -9992,7 +10690,6 @@ Package Contents :rtype: Dataset - .. py:method:: create_dataset_version_from_database_connector(dataset_id, object_name = None, columns = None, query_arguments = None, sql_query = None) Creates a new version of the specified dataset. @@ -10012,7 +10709,6 @@ Package Contents :rtype: DatasetVersion - .. py:method:: create_dataset_version_from_application_connector(dataset_id, dataset_config = None) Creates a new version of the specified dataset. @@ -10026,7 +10722,6 @@ Package Contents :rtype: DatasetVersion - .. py:method:: create_dataset_from_upload(table_name, file_format = None, csv_delimiter = None, is_documentset = False, extract_bounding_boxes = False, parsing_config = None, merge_file_schemas = False, document_processing_config = None) Creates a dataset and returns an upload ID that can be used to upload a file. @@ -10052,7 +10747,6 @@ Package Contents :rtype: Upload - .. py:method:: create_dataset_version_from_upload(dataset_id, file_format = None) Creates a new version of the specified dataset using a local file upload. @@ -10066,7 +10760,6 @@ Package Contents :rtype: Upload - .. py:method:: create_dataset_version_from_document_reprocessing(dataset_id, document_processing_config = None) Creates a new dataset version for a source docstore dataset with the provided document processing configuration. This does not re-import the data but uses the same data which is imported in the latest dataset version and only performs document processing on it. @@ -10080,7 +10773,6 @@ Package Contents :rtype: DatasetVersion - .. py:method:: create_streaming_dataset(table_name, primary_key = None, update_timestamp_key = None, lookup_keys = None) Creates a streaming dataset. Use a streaming dataset if your dataset is receiving information from multiple sources over an extended period of time. @@ -10098,7 +10790,6 @@ Package Contents :rtype: Dataset - .. py:method:: snapshot_streaming_data(dataset_id) Snapshots the current data in the streaming dataset. @@ -10110,7 +10801,6 @@ Package Contents :rtype: DatasetVersion - .. py:method:: set_dataset_column_data_type(dataset_id, column, data_type) Set a Dataset's column type. @@ -10126,8 +10816,7 @@ Package Contents :rtype: Dataset - - .. py:method:: create_dataset_from_streaming_connector(table_name, streaming_connector_id, streaming_args = None, refresh_schedule = None) + .. py:method:: create_dataset_from_streaming_connector(table_name, streaming_connector_id, dataset_config = None, refresh_schedule = None) Creates a dataset from a Streaming Connector @@ -10135,8 +10824,8 @@ Package Contents :type table_name: str :param streaming_connector_id: Unique String Identifier for the Streaming Connector to import the dataset from :type streaming_connector_id: str - :param streaming_args: Dictionary of arguments to read data from the streaming connector - :type streaming_args: dict + :param dataset_config: Streaming dataset config + :type dataset_config: StreamingConnectorDatasetConfig :param refresh_schedule: Cron time string format that describes a schedule to retrieve the latest version of the imported dataset. Time is specified in UTC. :type refresh_schedule: str @@ -10144,7 +10833,6 @@ Package Contents :rtype: Dataset - .. py:method:: set_streaming_retention_policy(dataset_id, retention_hours = None, retention_row_count = None, ignore_records_before_timestamp = None) Sets the streaming retention policy. @@ -10159,7 +10847,6 @@ Package Contents :type ignore_records_before_timestamp: int - .. py:method:: rename_database_connector(database_connector_id, name) Renames a Database Connector @@ -10170,7 +10857,6 @@ Package Contents :type name: str - .. py:method:: rename_application_connector(application_connector_id, name) Renames a Application Connector @@ -10181,7 +10867,6 @@ Package Contents :type name: str - .. py:method:: verify_database_connector(database_connector_id) Checks if Abacus.AI can access the specified database. @@ -10190,7 +10875,6 @@ Package Contents :type database_connector_id: str - .. py:method:: verify_file_connector(bucket) Checks to see if Abacus.AI can access the given bucket. @@ -10202,7 +10886,6 @@ Package Contents :rtype: FileConnectorVerification - .. py:method:: delete_database_connector(database_connector_id) Delete a database connector. @@ -10211,7 +10894,6 @@ Package Contents :type database_connector_id: str - .. py:method:: delete_application_connector(application_connector_id) Delete an application connector. @@ -10220,7 +10902,6 @@ Package Contents :type application_connector_id: str - .. py:method:: delete_file_connector(bucket) Deletes a file connector @@ -10229,7 +10910,6 @@ Package Contents :type bucket: str - .. py:method:: verify_application_connector(application_connector_id) Checks if Abacus.AI can access the application using the provided application connector ID. @@ -10238,7 +10918,6 @@ Package Contents :type application_connector_id: str - .. py:method:: set_azure_blob_connection_string(bucket, connection_string) Authenticates the specified Azure Blob Storage bucket using an authenticated Connection String. @@ -10252,7 +10931,6 @@ Package Contents :rtype: FileConnectorVerification - .. py:method:: verify_streaming_connector(streaming_connector_id) Checks to see if Abacus.AI can access the streaming connector. @@ -10261,7 +10939,6 @@ Package Contents :type streaming_connector_id: str - .. py:method:: rename_streaming_connector(streaming_connector_id, name) Renames a Streaming Connector @@ -10272,7 +10949,6 @@ Package Contents :type name: str - .. py:method:: delete_streaming_connector(streaming_connector_id) Delete a streaming connector. @@ -10281,7 +10957,6 @@ Package Contents :type streaming_connector_id: str - .. py:method:: create_streaming_token() Creates a streaming token for the specified project. Streaming tokens are used to authenticate requests when appending data to streaming datasets. @@ -10290,7 +10965,6 @@ Package Contents :rtype: StreamingAuthToken - .. py:method:: delete_streaming_token(streaming_token) Deletes the specified streaming token. @@ -10299,7 +10973,6 @@ Package Contents :type streaming_token: str - .. py:method:: delete_dataset(dataset_id) Deletes the specified dataset from the organization. @@ -10308,7 +10981,6 @@ Package Contents :type dataset_id: str - .. py:method:: get_docstore_page_data(doc_id, page, document_processing_config = None, document_processing_version = None) Returns the extracted page data for a document page. @@ -10326,7 +10998,6 @@ Package Contents :rtype: PageData - .. py:method:: get_docstore_document_data(doc_id, document_processing_config = None, document_processing_version = None, return_extracted_page_text = False) Returns the extracted data for a document. @@ -10344,7 +11015,6 @@ Package Contents :rtype: DocumentData - .. py:method:: extract_document_data(document = None, doc_id = None, document_processing_config = None, start_page = None, end_page = None, return_extracted_page_text = False) Extracts data from a document. @@ -10366,7 +11036,6 @@ Package Contents :rtype: DocumentData - .. py:method:: get_training_config_options(project_id, feature_group_ids = None, for_retrain = False, current_training_config = None) Retrieves the full initial description of the model training configuration options available for the specified project. The configuration options available are determined by the use case associated with the specified project. Refer to the [Use Case Documentation]({USE_CASES_URL}) for more information on use cases and use case-specific configuration options. @@ -10384,7 +11053,6 @@ Package Contents :rtype: list[TrainingConfigOptions] - .. py:method:: create_train_test_data_split_feature_group(project_id, training_config, feature_group_ids) Get the train and test data split without training the model. Only supported for models with custom algorithms. @@ -10400,7 +11068,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: train_model(project_id, name = None, training_config = None, feature_group_ids = None, refresh_schedule = None, custom_algorithms = None, custom_algorithms_only = False, custom_algorithm_configs = None, builtin_algorithms = None, cpu_size = None, memory = None, algorithm_training_configs = None) Create a new model and start its training in the given project. @@ -10434,7 +11101,6 @@ Package Contents :rtype: Model - .. py:method:: create_model_from_python(project_id, function_source_code, train_function_name, training_input_tables, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, name = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False, package_requirements = None, use_gpu = False, is_thread_safe = None) Initializes a new Model from user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -10477,7 +11143,6 @@ Package Contents :rtype: Model - .. py:method:: rename_model(model_id, name) Renames a model @@ -10488,7 +11153,6 @@ Package Contents :type name: str - .. py:method:: update_python_model(model_id, function_source_code = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None, is_thread_safe = None, training_config = None) Updates an existing Python Model using user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the `train` and `predict` functions with the materialized feature groups for those input feature groups. @@ -10527,7 +11191,6 @@ Package Contents :rtype: Model - .. py:method:: update_python_model_zip(model_id, train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) Updates an existing Python Model using a provided zip file. If a list of input feature groups are supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -10562,7 +11225,6 @@ Package Contents :rtype: Upload - .. py:method:: update_python_model_git(model_id, application_connector_id = None, branch_name = None, python_root = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, use_gpu = None) Updates an existing Python model using an existing Git application connector. If a list of input feature groups are supplied, these will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -10601,7 +11263,6 @@ Package Contents :rtype: Model - .. py:method:: set_model_training_config(model_id, training_config, feature_group_ids = None) Edits the default model training config @@ -10617,7 +11278,6 @@ Package Contents :rtype: Model - .. py:method:: set_model_objective(model_version, metric = None) Sets the best model for all model instances of the model based on the specified metric, and updates the training configuration to use the specified metric for any future model versions. @@ -10631,7 +11291,6 @@ Package Contents :type metric: str - .. py:method:: set_model_prediction_params(model_id, prediction_config) Sets the model prediction config for the model @@ -10645,7 +11304,6 @@ Package Contents :rtype: Model - .. py:method:: retrain_model(model_id, deployment_ids = None, feature_group_ids = None, custom_algorithms = None, builtin_algorithms = None, custom_algorithm_configs = None, cpu_size = None, memory = None, training_config = None, algorithm_training_configs = None) Retrains the specified model, with an option to choose the deployments to which the retraining will be deployed. @@ -10675,7 +11333,6 @@ Package Contents :rtype: Model - .. py:method:: delete_model(model_id) Deletes the specified model and all its versions. Models which are currently used in deployments cannot be deleted. @@ -10684,7 +11341,6 @@ Package Contents :type model_id: str - .. py:method:: delete_model_version(model_version) Deletes the specified model version. Model versions which are currently used in deployments cannot be deleted. @@ -10693,7 +11349,6 @@ Package Contents :type model_version: str - .. py:method:: export_model_artifact_as_feature_group(model_version, table_name, artifact_type = None) Exports metric artifact data for a model as a feature group. @@ -10709,7 +11364,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: set_default_model_algorithm(model_id = None, algorithm = None, data_cluster_type = None) Sets the model's algorithm to default for all new deployments @@ -10722,7 +11376,6 @@ Package Contents :type data_cluster_type: str - .. py:method:: get_custom_train_function_info(project_id, feature_group_names_for_training = None, training_data_parameter_name_override = None, training_config = None, custom_algorithm_config = None) Returns information about how to call the custom train function. @@ -10742,7 +11395,6 @@ Package Contents :rtype: CustomTrainFunctionInfo - .. py:method:: export_custom_model_version(model_version, output_location, algorithm = None) Bundle custom model artifacts to a zip file, and export to the specified location. @@ -10758,8 +11410,7 @@ Package Contents :rtype: ModelArtifactsExport - - .. py:method:: create_model_monitor(project_id, prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, include_interactive_performance_analysis = False) + .. py:method:: create_model_monitor(project_id, prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, exclude_interactive_performance_analysis = True, exclude_bias_analysis = None, exclude_performance_analysis = None, exclude_feature_drift_analysis = None, exclude_data_integrity_analysis = None) Runs a model monitor for the specified project. @@ -10789,14 +11440,21 @@ Package Contents :type feature_group_base_monitor_config: dict :param feature_group_comparison_monitor_config: Selection strategy for the feature_group 1 with the feature group version if selected. :type feature_group_comparison_monitor_config: dict - :param include_interactive_performance_analysis: Whether to include interactive performance analysis. - :type include_interactive_performance_analysis: bool + :param exclude_interactive_performance_analysis: Whether to exclude interactive performance analysis. Defaults to True if not provided. + :type exclude_interactive_performance_analysis: bool + :param exclude_bias_analysis: Whether to exclude bias analysis in the model monitor. For default value bias analysis is included. + :type exclude_bias_analysis: bool + :param exclude_performance_analysis: Whether to exclude performance analysis in the model monitor. For default value performance analysis is included. + :type exclude_performance_analysis: bool + :param exclude_feature_drift_analysis: Whether to exclude feature drift analysis in the model monitor. For default value feature drift analysis is included. + :type exclude_feature_drift_analysis: bool + :param exclude_data_integrity_analysis: Whether to exclude data integrity analysis in the model monitor. For default value data integrity analysis is included. + :type exclude_data_integrity_analysis: bool :returns: The new model monitor that was created. :rtype: ModelMonitor - .. py:method:: rerun_model_monitor(model_monitor_id) Re-runs the specified model monitor. @@ -10808,7 +11466,6 @@ Package Contents :rtype: ModelMonitor - .. py:method:: rename_model_monitor(model_monitor_id, name) Renames a model monitor @@ -10819,7 +11476,6 @@ Package Contents :type name: str - .. py:method:: delete_model_monitor(model_monitor_id) Deletes the specified Model Monitor and all its versions. @@ -10828,7 +11484,6 @@ Package Contents :type model_monitor_id: str - .. py:method:: delete_model_monitor_version(model_monitor_version) Deletes the specified model monitor version. @@ -10837,7 +11492,6 @@ Package Contents :type model_monitor_version: str - .. py:method:: create_vision_drift_monitor(project_id, prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) Runs a vision drift monitor for the specified project. @@ -10863,7 +11517,6 @@ Package Contents :rtype: ModelMonitor - .. py:method:: create_nlp_drift_monitor(project_id, prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) Runs an NLP drift monitor for the specified project. @@ -10889,7 +11542,6 @@ Package Contents :rtype: ModelMonitor - .. py:method:: create_forecasting_monitor(project_id, name, prediction_feature_group_id, training_feature_group_id, training_forecast_config, prediction_forecast_config, forecast_frequency, refresh_schedule = None) Runs a forecasting monitor for the specified project. @@ -10915,7 +11567,6 @@ Package Contents :rtype: ModelMonitor - .. py:method:: create_eda(project_id, feature_group_id, name, refresh_schedule = None, include_collinearity = False, include_data_consistency = False, collinearity_keys = None, primary_keys = None, data_consistency_test_config = None, data_consistency_reference_config = None, feature_mappings = None, forecast_frequency = None) Run an Exploratory Data Analysis (EDA) for the specified project. @@ -10949,7 +11600,6 @@ Package Contents :rtype: Eda - .. py:method:: rerun_eda(eda_id) Reruns the specified EDA object. @@ -10961,7 +11611,6 @@ Package Contents :rtype: Eda - .. py:method:: rename_eda(eda_id, name) Renames an EDA @@ -10972,7 +11621,6 @@ Package Contents :type name: str - .. py:method:: delete_eda(eda_id) Deletes the specified EDA and all its versions. @@ -10981,7 +11629,6 @@ Package Contents :type eda_id: str - .. py:method:: delete_eda_version(eda_version) Deletes the specified EDA version. @@ -10990,7 +11637,6 @@ Package Contents :type eda_version: str - .. py:method:: create_holdout_analysis(name, model_id, feature_group_ids, model_version = None, algorithm = None) Create a holdout analysis for a model @@ -11010,7 +11656,6 @@ Package Contents :rtype: HoldoutAnalysis - .. py:method:: rerun_holdout_analysis(holdout_analysis_id, model_version = None, algorithm = None) Rerun a holdout analysis. A different model version and algorithm can be specified which should be under the same model. @@ -11026,7 +11671,6 @@ Package Contents :rtype: HoldoutAnalysisVersion - .. py:method:: create_monitor_alert(project_id, alert_name, condition_config, action_config, model_monitor_id = None, realtime_monitor_id = None) Create a monitor alert for the given conditions and monitor. We can create monitor alert either for model monitor or real-time monitor. @@ -11048,7 +11692,6 @@ Package Contents :rtype: MonitorAlert - .. py:method:: update_monitor_alert(monitor_alert_id, alert_name = None, condition_config = None, action_config = None) Update monitor alert @@ -11066,7 +11709,6 @@ Package Contents :rtype: MonitorAlert - .. py:method:: run_monitor_alert(monitor_alert_id) Reruns a given monitor alert from latest monitor instance @@ -11078,7 +11720,6 @@ Package Contents :rtype: MonitorAlert - .. py:method:: delete_monitor_alert(monitor_alert_id) Delets a monitor alert @@ -11087,7 +11728,6 @@ Package Contents :type monitor_alert_id: str - .. py:method:: create_prediction_operator(name, project_id, source_code = None, predict_function_name = None, initialize_function_name = None, feature_group_ids = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = False) Create a new prediction operator. @@ -11117,7 +11757,6 @@ Package Contents :rtype: PredictionOperator - .. py:method:: update_prediction_operator(prediction_operator_id, name = None, feature_group_ids = None, source_code = None, initialize_function_name = None, predict_function_name = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) Update an existing prediction operator. @@ -11147,7 +11786,6 @@ Package Contents :rtype: PredictionOperator - .. py:method:: delete_prediction_operator(prediction_operator_id) Delete an existing prediction operator. @@ -11156,7 +11794,6 @@ Package Contents :type prediction_operator_id: str - .. py:method:: deploy_prediction_operator(prediction_operator_id, auto_deploy = True) Deploy the prediction operator. @@ -11170,7 +11807,6 @@ Package Contents :rtype: Deployment - .. py:method:: create_prediction_operator_version(prediction_operator_id) Create a new version of the prediction operator. @@ -11182,7 +11818,6 @@ Package Contents :rtype: PredictionOperatorVersion - .. py:method:: delete_prediction_operator_version(prediction_operator_version) Delete a prediction operator version. @@ -11191,7 +11826,6 @@ Package Contents :type prediction_operator_version: str - .. py:method:: create_deployment(name = None, model_id = None, model_version = None, algorithm = None, feature_group_id = None, project_id = None, description = None, calls_per_second = None, auto_deploy = True, start = True, enable_batch_streaming_updates = False, skip_metrics_check = False, model_deployment_config = None) Creates a deployment with the specified name and description for the specified model or feature group. @@ -11230,7 +11864,6 @@ Package Contents :rtype: Deployment - .. py:method:: create_deployment_token(project_id, name = None) Creates a deployment token for the specified project. @@ -11247,7 +11880,6 @@ Package Contents :rtype: DeploymentAuthToken - .. py:method:: update_deployment(deployment_id, description = None, auto_deploy = None, skip_metrics_check = None) Updates a deployment's properties. @@ -11262,7 +11894,6 @@ Package Contents :type skip_metrics_check: bool - .. py:method:: rename_deployment(deployment_id, name) Updates a deployment's name @@ -11273,7 +11904,6 @@ Package Contents :type name: str - .. py:method:: set_auto_deployment(deployment_id, enable = None) Enable or disable auto deployment for the specified deployment. @@ -11287,7 +11917,6 @@ Package Contents :type enable: bool - .. py:method:: set_deployment_model_version(deployment_id, model_version, algorithm = None, model_deployment_config = None) Promotes a model version and/or algorithm to be the active served deployment version @@ -11302,7 +11931,6 @@ Package Contents :type model_deployment_config: dict - .. py:method:: set_deployment_feature_group_version(deployment_id, feature_group_version) Promotes a feature group version to be served in the deployment. @@ -11313,7 +11941,6 @@ Package Contents :type feature_group_version: str - .. py:method:: set_deployment_prediction_operator_version(deployment_id, prediction_operator_version) Promotes a prediction operator version to be served in the deployment. @@ -11324,7 +11951,6 @@ Package Contents :type prediction_operator_version: str - .. py:method:: start_deployment(deployment_id) Restarts the specified deployment that was previously suspended. @@ -11333,7 +11959,6 @@ Package Contents :type deployment_id: str - .. py:method:: stop_deployment(deployment_id) Stops the specified deployment. @@ -11342,7 +11967,6 @@ Package Contents :type deployment_id: str - .. py:method:: delete_deployment(deployment_id) Deletes the specified deployment. The deployment's models will not be affected. Note that the deployments are not recoverable after they are deleted. @@ -11351,7 +11975,6 @@ Package Contents :type deployment_id: str - .. py:method:: delete_deployment_token(deployment_token) Deletes the specified deployment token. @@ -11360,7 +11983,6 @@ Package Contents :type deployment_token: str - .. py:method:: set_deployment_feature_group_export_file_connector_output(deployment_id, file_format = None, output_location = None) Sets the export output for the Feature Group Deployment to be a file connector. @@ -11373,7 +11995,6 @@ Package Contents :type output_location: str - .. py:method:: set_deployment_feature_group_export_database_connector_output(deployment_id, database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) Sets the export output for the Feature Group Deployment to a Database connector. @@ -11394,7 +12015,6 @@ Package Contents :type additional_id_columns: list - .. py:method:: remove_deployment_feature_group_export_output(deployment_id) Removes the export type that is set for the Feature Group Deployment @@ -11403,7 +12023,6 @@ Package Contents :type deployment_id: str - .. py:method:: set_default_prediction_arguments(deployment_id, prediction_arguments, set_as_override = False) Sets the deployment config. @@ -11419,7 +12038,6 @@ Package Contents :rtype: Deployment - .. py:method:: create_deployment_alert(deployment_id, alert_name, condition_config, action_config) Create a deployment alert for the given conditions. @@ -11440,7 +12058,6 @@ Package Contents :rtype: MonitorAlert - .. py:method:: create_realtime_monitor(deployment_id, realtime_monitor_schedule = None, lookback_time = None) Real time monitors compute and monitor metrics of real time prediction data. @@ -11456,7 +12073,6 @@ Package Contents :rtype: RealtimeMonitor - .. py:method:: update_realtime_monitor(realtime_monitor_id, realtime_monitor_schedule = None, lookback_time = None) Update the real-time monitor associated with the real-time monitor id. @@ -11472,7 +12088,6 @@ Package Contents :rtype: RealtimeMonitor - .. py:method:: delete_realtime_monitor(realtime_monitor_id) Delete the real-time monitor associated with the real-time monitor id. @@ -11481,7 +12096,6 @@ Package Contents :type realtime_monitor_id: str - .. py:method:: create_refresh_policy(name, cron, refresh_type, project_id = None, dataset_ids = [], feature_group_id = None, model_ids = [], deployment_ids = [], batch_prediction_ids = [], model_monitor_ids = [], notebook_id = None, prediction_operator_id = None, feature_group_export_config = None) Creates a refresh policy with a particular cron pattern and refresh type. The cron is specified in UTC time. @@ -11520,7 +12134,6 @@ Package Contents :rtype: RefreshPolicy - .. py:method:: delete_refresh_policy(refresh_policy_id) Delete a refresh policy. @@ -11529,7 +12142,6 @@ Package Contents :type refresh_policy_id: str - .. py:method:: pause_refresh_policy(refresh_policy_id) Pauses a refresh policy @@ -11538,7 +12150,6 @@ Package Contents :type refresh_policy_id: str - .. py:method:: resume_refresh_policy(refresh_policy_id) Resumes a refresh policy @@ -11547,7 +12158,6 @@ Package Contents :type refresh_policy_id: str - .. py:method:: run_refresh_policy(refresh_policy_id) Force a run of the refresh policy. @@ -11556,7 +12166,6 @@ Package Contents :type refresh_policy_id: str - .. py:method:: update_refresh_policy(refresh_policy_id, name = None, cron = None, feature_group_export_config = None) Update the name or cron string of a refresh policy @@ -11574,7 +12183,6 @@ Package Contents :rtype: RefreshPolicy - .. py:method:: lookup_features(deployment_token, deployment_id, query_data, limit_results = None, result_columns = None) Returns the feature group deployed in the feature store project. @@ -11591,7 +12199,6 @@ Package Contents :type result_columns: list - .. py:method:: predict(deployment_token, deployment_id, query_data) Returns a prediction for Predictive Modeling @@ -11604,7 +12211,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_multiple(deployment_token, deployment_id, query_data) Returns a list of predictions for predictive modeling. @@ -11617,7 +12223,6 @@ Package Contents :type query_data: list - .. py:method:: predict_from_datasets(deployment_token, deployment_id, query_data) Returns a list of predictions for Predictive Modeling. @@ -11630,7 +12235,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_lead(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user being a lead based on their interaction with the service/product and their own attributes (e.g. income, assets, credit score, etc.). Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'user_id' mapped to mapping 'LEAD_ID' in our system). @@ -11647,7 +12251,6 @@ Package Contents :type explainer_type: str - .. py:method:: predict_churn(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user to churn out in response to their interactions with the item/product/service. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'churn_result' mapped to mapping 'CHURNED_YN' in our system). @@ -11664,7 +12267,6 @@ Package Contents :type explainer_type: str - .. py:method:: predict_takeover(deployment_token, deployment_id, query_data) Returns a probability for each class label associated with the types of fraud or a 'yes' or 'no' type label for the possibility of fraud. Note that the inputs to this method, wherever applicable, will be the column names in the dataset mapped to the column mappings in our system (e.g., column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -11677,7 +12279,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_fraud(deployment_token, deployment_id, query_data) Returns the probability of a transaction performed under a specific account being fraudulent or not. Note that the inputs to this method, wherever applicable, should be the column names in your dataset mapped to the column mappings in our system (e.g. column 'account_number' mapped to the mapping 'ACCOUNT_ID' in our system). @@ -11690,7 +12291,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_class(deployment_token, deployment_id, query_data, threshold = None, threshold_class = None, thresholds = None, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a classification prediction @@ -11717,7 +12317,6 @@ Package Contents :type explainer_type: str - .. py:method:: predict_target(deployment_token, deployment_id, query_data, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a prediction from a classification or regression model. Optionally, includes explanations. @@ -11738,7 +12337,6 @@ Package Contents :type explainer_type: str - .. py:method:: get_anomalies(deployment_token, deployment_id, threshold = None, histogram = False) Returns a list of anomalies from the training dataset. @@ -11753,7 +12351,6 @@ Package Contents :type histogram: bool - .. py:method:: get_timeseries_anomalies(deployment_token, deployment_id, start_timestamp = None, end_timestamp = None, query_data = None, get_all_item_data = False, series_ids = None) Returns a list of anomalous timestamps from the training dataset. @@ -11774,7 +12371,6 @@ Package Contents :type series_ids: list - .. py:method:: is_anomaly(deployment_token, deployment_id, query_data = None) Returns a list of anomaly attributes based on login information for a specified account. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -11787,7 +12383,6 @@ Package Contents :type query_data: dict - .. py:method:: get_event_anomaly_score(deployment_token, deployment_id, query_data = None) Returns an anomaly score for an event. @@ -11800,7 +12395,6 @@ Package Contents :type query_data: dict - .. py:method:: get_forecast(deployment_token, deployment_id, query_data, future_data = None, num_predictions = None, prediction_start = None, explain_predictions = False, explainer_type = None, get_item_data = False) Returns a list of forecasts for a given entity under the specified project deployment. Note that the inputs to the deployed model will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'holiday_yn' mapped to mapping 'FUTURE' in our system). @@ -11825,7 +12419,6 @@ Package Contents :type get_item_data: bool - .. py:method:: get_k_nearest(deployment_token, deployment_id, vector, k = None, distance = None, include_score = False, catalog_id = None) Returns the k nearest neighbors for the provided embedding vector. @@ -11846,7 +12439,6 @@ Package Contents :type catalog_id: str - .. py:method:: get_multiple_k_nearest(deployment_token, deployment_id, queries) Returns the k nearest neighbors for the queries provided. @@ -11859,7 +12451,6 @@ Package Contents :type queries: list - .. py:method:: get_labels(deployment_token, deployment_id, query_data, return_extracted_entities = False) Returns a list of scored labels for a document. @@ -11874,7 +12465,6 @@ Package Contents :type return_extracted_entities: bool - .. py:method:: get_entities_from_pdf(deployment_token, deployment_id, pdf = None, doc_id = None, return_extracted_features = False, verbose = False, save_extracted_features = None) Extracts text from the provided PDF and returns a list of recognized labels and their scores. @@ -11895,7 +12485,6 @@ Package Contents :type save_extracted_features: bool - .. py:method:: get_recommendations(deployment_token, deployment_id, query_data, num_items = None, page = None, exclude_item_ids = None, score_field = None, scaling_factors = None, restrict_items = None, exclude_items = None, explore_fraction = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of recommendations for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'time' mapped to mapping 'TIMESTAMP' in our system). @@ -11926,7 +12515,6 @@ Package Contents :type diversity_max_results_per_value: int - .. py:method:: get_personalized_ranking(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, scaling_factors = None) Returns a list of items with personalized promotions for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -11945,7 +12533,6 @@ Package Contents :type scaling_factors: list - .. py:method:: get_ranked_items(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, score_field = None, scaling_factors = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of re-ranked items for a selected user when a list of items is required to be reranked according to the user's preferences. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -11970,7 +12557,6 @@ Package Contents :type diversity_max_results_per_value: int - .. py:method:: get_related_items(deployment_token, deployment_id, query_data, num_items = None, page = None, scaling_factors = None, restrict_items = None, exclude_items = None) Returns a list of related items for a given item under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -11993,7 +12579,6 @@ Package Contents :type exclude_items: list - .. py:method:: get_chat_response(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False) Return a chat response which continues the conversation based on the input messages and search results. @@ -12022,7 +12607,6 @@ Package Contents :type ignore_documents: bool - .. py:method:: get_chat_response_with_binary_data(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a chat response which continues the conversation based on the input messages and search results. @@ -12053,7 +12637,6 @@ Package Contents :type attachments: None - .. py:method:: get_conversation_response(deployment_id, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, deployment_token = None, doc_infos = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -12088,7 +12671,6 @@ Package Contents :type doc_infos: list - .. py:method:: get_conversation_response_with_binary_data(deployment_id, deployment_token, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -12123,7 +12705,6 @@ Package Contents :type attachments: None - .. py:method:: get_search_results(deployment_token, deployment_id, query_data, num = 15) Return the most relevant search results to the search query from the uploaded documents. @@ -12138,7 +12719,6 @@ Package Contents :type num: int - .. py:method:: get_sentiment(deployment_token, deployment_id, document) Predicts sentiment on a document @@ -12151,7 +12731,6 @@ Package Contents :type document: str - .. py:method:: get_entailment(deployment_token, deployment_id, document) Predicts the classification of the document @@ -12164,7 +12743,6 @@ Package Contents :type document: str - .. py:method:: get_classification(deployment_token, deployment_id, document) Predicts the classification of the document @@ -12177,7 +12755,6 @@ Package Contents :type document: str - .. py:method:: get_summary(deployment_token, deployment_id, query_data) Returns a JSON of the predicted summary for the given document. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'text' mapped to mapping 'DOCUMENT' in our system). @@ -12190,7 +12767,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_language(deployment_token, deployment_id, query_data) Predicts the language of the text @@ -12203,7 +12779,6 @@ Package Contents :type query_data: str - .. py:method:: get_assignments(deployment_token, deployment_id, query_data, forced_assignments = None, solve_time_limit_seconds = None, include_all_assignments = False) Get all positive assignments that match a query. @@ -12222,7 +12797,6 @@ Package Contents :type include_all_assignments: bool - .. py:method:: get_alternative_assignments(deployment_token, deployment_id, query_data, add_constraints = None, solve_time_limit_seconds = None, best_alternate_only = False) Get alternative positive assignments for given query. Optimal assignments are ignored and the alternative assignments are returned instead. @@ -12241,7 +12815,6 @@ Package Contents :type best_alternate_only: bool - .. py:method:: check_constraints(deployment_token, deployment_id, query_data) Check for any constraints violated by the overrides. @@ -12254,7 +12827,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_with_binary_data(deployment_token, deployment_id, blob) Make predictions for a given blob, e.g. image, audio @@ -12267,7 +12839,6 @@ Package Contents :type blob: io.TextIOBase - .. py:method:: describe_image(deployment_token, deployment_id, image, categories, top_n = None) Describe the similarity between an image and a list of categories. @@ -12284,7 +12855,6 @@ Package Contents :type top_n: int - .. py:method:: get_text_from_document(deployment_token, deployment_id, document = None, adjust_doc_orientation = False, save_predicted_pdf = False, save_extracted_features = False) Generate text from a document @@ -12303,7 +12873,6 @@ Package Contents :type save_extracted_features: bool - .. py:method:: transcribe_audio(deployment_token, deployment_id, audio) Transcribe the audio @@ -12316,7 +12885,6 @@ Package Contents :type audio: io.TextIOBase - .. py:method:: classify_image(deployment_token, deployment_id, image = None, doc_id = None) Classify an image. @@ -12331,7 +12899,6 @@ Package Contents :type doc_id: str - .. py:method:: classify_pdf(deployment_token, deployment_id, pdf = None) Returns a classification prediction from a PDF @@ -12344,7 +12911,6 @@ Package Contents :type pdf: io.TextIOBase - .. py:method:: get_cluster(deployment_token, deployment_id, query_data) Predicts the cluster for given data. @@ -12357,7 +12923,6 @@ Package Contents :type query_data: dict - .. py:method:: get_objects_from_image(deployment_token, deployment_id, image) Classify an image. @@ -12370,7 +12935,6 @@ Package Contents :type image: io.TextIOBase - .. py:method:: score_image(deployment_token, deployment_id, image) Score on image. @@ -12383,7 +12947,6 @@ Package Contents :type image: io.TextIOBase - .. py:method:: transfer_style(deployment_token, deployment_id, source_image, style_image) Change the source image to adopt the visual style from the style image. @@ -12398,7 +12961,6 @@ Package Contents :type style_image: io.TextIOBase - .. py:method:: generate_image(deployment_token, deployment_id, query_data) Generate an image from text prompt. @@ -12411,7 +12973,6 @@ Package Contents :type query_data: dict - .. py:method:: execute_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -12426,7 +12987,6 @@ Package Contents :type keyword_arguments: dict - .. py:method:: execute_conversation_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, regenerate = False, doc_infos = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -12449,7 +13009,6 @@ Package Contents :type doc_infos: list - .. py:method:: lookup_matches(deployment_token, deployment_id, data = None, filters = None, num = None, result_columns = None, max_words = None, num_retrieval_margin_words = None, max_words_per_chunk = None, score_multiplier_column = None, min_score = None, required_phrases = None, filter_clause = None, crowding_limits = None) Lookup document retrievers and return the matching documents from the document retriever deployed with given query. @@ -12492,7 +13051,6 @@ Package Contents :rtype: list[DocumentRetrieverLookupResult] - .. py:method:: get_completion(deployment_token, deployment_id, prompt) Returns the finetuned LLM generated completion of the prompt. @@ -12505,7 +13063,6 @@ Package Contents :type prompt: str - .. py:method:: execute_agent_with_binary_data(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, blobs = None) Executes a deployed AI agent function with binary data as inputs. @@ -12529,7 +13086,6 @@ Package Contents :rtype: AgentDataExecutionResult - .. py:method:: create_batch_prediction(deployment_id, table_name = None, name = None, global_prediction_args = None, batch_prediction_args = None, explanations = False, output_format = None, output_location = None, database_connector_id = None, database_output_config = None, refresh_schedule = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, input_feature_groups = None) Creates a batch prediction job description for the given deployment. @@ -12569,7 +13125,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: start_batch_prediction(batch_prediction_id) Creates a new batch prediction version job for a given batch prediction job description. @@ -12581,7 +13136,6 @@ Package Contents :rtype: BatchPredictionVersion - .. py:method:: update_batch_prediction(batch_prediction_id, deployment_id = None, global_prediction_args = None, batch_prediction_args = None, explanations = None, output_format = None, csv_input_prefix = None, csv_prediction_prefix = None, csv_explanations_prefix = None, output_includes_metadata = None, result_input_columns = None, name = None) Update a batch prediction job description. @@ -12611,7 +13165,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_file_connector_output(batch_prediction_id, output_format = None, output_location = None) Updates the file connector output configuration of the batch prediction @@ -12627,7 +13180,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_database_connector_output(batch_prediction_id, database_connector_id = None, database_output_config = None) Updates the database connector output configuration of the batch prediction @@ -12643,7 +13195,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_feature_group_output(batch_prediction_id, table_name) Creates a feature group and sets it as the batch prediction output. @@ -12657,7 +13208,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_output_to_console(batch_prediction_id) Sets the batch prediction output to the console, clearing both the file connector and database connector configurations. @@ -12669,7 +13219,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_feature_group(batch_prediction_id, feature_group_type, feature_group_id = None) Sets the batch prediction input feature group. @@ -12685,7 +13234,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: set_batch_prediction_dataset_remap(batch_prediction_id, dataset_id_remap) For the purpose of this batch prediction, will swap out datasets in the training feature groups @@ -12699,7 +13247,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: delete_batch_prediction(batch_prediction_id) Deletes a batch prediction and associated data, such as associated monitors. @@ -12708,7 +13255,6 @@ Package Contents :type batch_prediction_id: str - .. py:method:: upsert_item_embeddings(streaming_token, model_id, item_id, vector, catalog_id = None) Upserts an embedding vector for an item id for a model_id. @@ -12725,7 +13271,6 @@ Package Contents :type catalog_id: str - .. py:method:: delete_item_embeddings(streaming_token, model_id, item_ids, catalog_id = None) Deletes KNN embeddings for a list of item IDs for a given model ID. @@ -12740,7 +13285,6 @@ Package Contents :type catalog_id: str - .. py:method:: upsert_multiple_item_embeddings(streaming_token, model_id, upserts, catalog_id = None) Upserts a knn embedding for multiple item ids for a model_id. @@ -12755,7 +13299,6 @@ Package Contents :type catalog_id: str - .. py:method:: append_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -12768,7 +13311,6 @@ Package Contents :type data: dict - .. py:method:: append_multiple_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -12781,7 +13323,6 @@ Package Contents :type data: list - .. py:method:: upsert_data(feature_group_id, data, streaming_token = None) Update new data into the feature group for a given lookup key record ID if the record ID is found; otherwise, insert new data into the feature group. @@ -12797,7 +13338,6 @@ Package Contents :rtype: FeatureGroupRow - .. py:method:: delete_data(feature_group_id, primary_key) Deletes a row from the feature group given the primary key @@ -12808,7 +13348,6 @@ Package Contents :type primary_key: str - .. py:method:: describe_feature_group_row_process_by_key(deployment_id, primary_key_value) Gets the feature group row process. @@ -12822,7 +13361,6 @@ Package Contents :rtype: FeatureGroupRowProcess - .. py:method:: list_feature_group_row_processes(deployment_id, limit = None, status = None) Gets a list of feature group row processes. @@ -12838,7 +13376,6 @@ Package Contents :rtype: list[FeatureGroupRowProcess] - .. py:method:: get_feature_group_row_process_summary(deployment_id) Gets a summary of the statuses of the individual feature group processes. @@ -12850,7 +13387,6 @@ Package Contents :rtype: FeatureGroupRowProcessSummary - .. py:method:: reset_feature_group_row_process_by_key(deployment_id, primary_key_value) Resets a feature group row process so that it can be reprocessed @@ -12864,7 +13400,6 @@ Package Contents :rtype: FeatureGroupRowProcess - .. py:method:: get_feature_group_row_process_logs_by_key(deployment_id, primary_key_value) Gets the logs for a feature group row process @@ -12878,7 +13413,6 @@ Package Contents :rtype: FeatureGroupRowProcessLogs - .. py:method:: create_python_function(name, source_code = None, function_name = None, function_variable_mappings = None, package_requirements = None, function_type = 'FEATURE_GROUP') Creates a custom Python function that is reusable. @@ -12900,7 +13434,6 @@ Package Contents :rtype: PythonFunction - .. py:method:: update_python_function(name, source_code = None, function_name = None, function_variable_mappings = None, package_requirements = None) Update custom python function with user inputs for the given python function. @@ -12920,7 +13453,6 @@ Package Contents :rtype: PythonFunction - .. py:method:: delete_python_function(name) Removes an existing Python function. @@ -12929,7 +13461,6 @@ Package Contents :type name: str - .. py:method:: create_pipeline(pipeline_name, project_id = None, cron = None, is_prod = None) Creates a pipeline for executing multiple steps. @@ -12947,7 +13478,6 @@ Package Contents :rtype: Pipeline - .. py:method:: describe_pipeline(pipeline_id) Describes a given pipeline. @@ -12959,7 +13489,6 @@ Package Contents :rtype: Pipeline - .. py:method:: describe_pipeline_by_name(pipeline_name) Describes a given pipeline. @@ -12971,7 +13500,6 @@ Package Contents :rtype: Pipeline - .. py:method:: update_pipeline(pipeline_id, project_id = None, pipeline_variable_mappings = None, cron = None, is_prod = None) Updates a pipeline for executing multiple steps. @@ -12991,7 +13519,6 @@ Package Contents :rtype: Pipeline - .. py:method:: rename_pipeline(pipeline_id, pipeline_name) Renames a pipeline. @@ -13005,7 +13532,6 @@ Package Contents :rtype: Pipeline - .. py:method:: delete_pipeline(pipeline_id) Deletes a pipeline. @@ -13014,7 +13540,6 @@ Package Contents :type pipeline_id: str - .. py:method:: list_pipeline_versions(pipeline_id, limit = 200) Lists the pipeline versions for a specified pipeline @@ -13028,7 +13553,6 @@ Package Contents :rtype: list[PipelineVersion] - .. py:method:: run_pipeline(pipeline_id, pipeline_variable_mappings = None) Runs a specified pipeline with the arguments provided. @@ -13042,7 +13566,6 @@ Package Contents :rtype: PipelineVersion - .. py:method:: reset_pipeline_version(pipeline_version, steps = None, include_downstream_steps = True) Reruns a pipeline version for the given steps and downstream steps if specified. @@ -13058,7 +13581,6 @@ Package Contents :rtype: PipelineVersion - .. py:method:: create_pipeline_step(pipeline_id, step_name, function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) Creates a step in a given pipeline. @@ -13090,7 +13612,6 @@ Package Contents :rtype: Pipeline - .. py:method:: delete_pipeline_step(pipeline_step_id) Deletes a step from a pipeline. @@ -13099,7 +13620,6 @@ Package Contents :type pipeline_step_id: str - .. py:method:: update_pipeline_step(pipeline_step_id, function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) Creates a step in a given pipeline. @@ -13129,7 +13649,6 @@ Package Contents :rtype: PipelineStep - .. py:method:: rename_pipeline_step(pipeline_step_id, step_name) Renames a step in a given pipeline. @@ -13143,7 +13662,6 @@ Package Contents :rtype: PipelineStep - .. py:method:: unset_pipeline_refresh_schedule(pipeline_id) Deletes the refresh schedule for a given pipeline. @@ -13155,7 +13673,6 @@ Package Contents :rtype: Pipeline - .. py:method:: pause_pipeline_refresh_schedule(pipeline_id) Pauses the refresh schedule for a given pipeline. @@ -13167,7 +13684,6 @@ Package Contents :rtype: Pipeline - .. py:method:: resume_pipeline_refresh_schedule(pipeline_id) Resumes the refresh schedule for a given pipeline. @@ -13179,7 +13695,6 @@ Package Contents :rtype: Pipeline - .. py:method:: skip_pending_pipeline_version_steps(pipeline_version) Skips pending steps in a pipeline version. @@ -13191,7 +13706,6 @@ Package Contents :rtype: PipelineVersion - .. py:method:: create_graph_dashboard(project_id, name, python_function_ids = None) Create a plot dashboard given selected python plots @@ -13207,7 +13721,6 @@ Package Contents :rtype: GraphDashboard - .. py:method:: delete_graph_dashboard(graph_dashboard_id) Deletes a graph dashboard @@ -13216,7 +13729,6 @@ Package Contents :type graph_dashboard_id: str - .. py:method:: update_graph_dashboard(graph_dashboard_id, name = None, python_function_ids = None) Updates a graph dashboard @@ -13232,7 +13744,6 @@ Package Contents :rtype: GraphDashboard - .. py:method:: add_graph_to_dashboard(python_function_id, graph_dashboard_id, function_variable_mappings = None, name = None) Add a python plot function to a dashboard @@ -13250,7 +13761,6 @@ Package Contents :rtype: GraphDashboard - .. py:method:: update_graph_to_dashboard(graph_reference_id, function_variable_mappings = None, name = None) Update a python plot function to a dashboard @@ -13266,7 +13776,6 @@ Package Contents :rtype: GraphDashboard - .. py:method:: delete_graph_from_dashboard(graph_reference_id) Deletes a python plot function from a dashboard @@ -13275,7 +13784,6 @@ Package Contents :type graph_reference_id: str - .. py:method:: create_algorithm(name, problem_type, source_code = None, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, config_options = None, is_default_enabled = False, project_id = None, use_gpu = False, package_requirements = None) Creates a custom algorithm that is re-usable for model training. @@ -13313,7 +13821,6 @@ Package Contents :rtype: Algorithm - .. py:method:: delete_algorithm(algorithm) Deletes the specified customer algorithm. @@ -13322,7 +13829,6 @@ Package Contents :type algorithm: str - .. py:method:: update_algorithm(algorithm, source_code = None, training_data_parameter_names_mapping = None, training_config_parameter_name = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, config_options = None, is_default_enabled = None, use_gpu = None, package_requirements = None) Update a custom algorithm for the given algorithm name. If source code is provided, all function names for the source code must also be provided. @@ -13356,7 +13862,6 @@ Package Contents :rtype: Algorithm - .. py:method:: list_builtin_algorithms(project_id, feature_group_ids, training_config = None) Return list of built-in algorithms based on given input data and training config. @@ -13372,7 +13877,6 @@ Package Contents :rtype: list[Algorithm] - .. py:method:: create_custom_loss_function_with_source_code(name, loss_function_type, loss_function_name, loss_function_source_code) Registers a new custom loss function which can be used as an objective function during model training. @@ -13390,7 +13894,6 @@ Package Contents :rtype: CustomLossFunction - .. py:method:: update_custom_loss_function_with_source_code(name, loss_function_name, loss_function_source_code) Updates a previously registered custom loss function with a new function implementation. @@ -13406,7 +13909,6 @@ Package Contents :rtype: CustomLossFunction - .. py:method:: delete_custom_loss_function(name) Deletes a previously registered custom loss function. @@ -13415,7 +13917,6 @@ Package Contents :type name: str - .. py:method:: create_custom_metric(name, problem_type, custom_metric_function_name = None, source_code = None) Registers a new custom metric which can be used as an evaluation metric for the trained model. @@ -13433,7 +13934,6 @@ Package Contents :rtype: CustomMetric - .. py:method:: update_custom_metric(name, custom_metric_function_name, source_code) Updates a previously registered custom metric with a new function implementation. @@ -13449,7 +13949,6 @@ Package Contents :rtype: CustomMetric - .. py:method:: delete_custom_metric(name) Deletes a previously registered custom metric. @@ -13458,7 +13957,6 @@ Package Contents :type name: str - .. py:method:: create_module(name, source_code = None) Creates a module that's re-usable in customer's code, e.g. python function, bring your own algorithm and etc. @@ -13472,7 +13970,6 @@ Package Contents :rtype: Module - .. py:method:: delete_module(name) Deletes the specified customer module. @@ -13481,7 +13978,6 @@ Package Contents :type name: str - .. py:method:: update_module(name, source_code = None) Update the module. @@ -13495,7 +13991,6 @@ Package Contents :rtype: Module - .. py:method:: create_organization_secret(secret_key, value) Creates a secret which can be accessed in functions and notebooks. @@ -13509,7 +14004,6 @@ Package Contents :rtype: OrganizationSecret - .. py:method:: delete_organization_secret(secret_key) Deletes a secret. @@ -13518,7 +14012,6 @@ Package Contents :type secret_key: str - .. py:method:: update_organization_secret(secret_key, value) Updates a secret. @@ -13532,7 +14025,6 @@ Package Contents :rtype: OrganizationSecret - .. py:method:: set_natural_language_explanation(short_explanation, long_explanation, feature_group_id = None, feature_group_version = None, model_id = None) Saves the natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version @@ -13549,7 +14041,6 @@ Package Contents :type model_id: str - .. py:method:: create_chat_session(project_id, name = None) Creates a chat session with Data Science Co-pilot. @@ -13563,7 +14054,6 @@ Package Contents :rtype: ChatSession - .. py:method:: delete_chat_message(chat_session_id, message_index) Deletes a message in a chat session and its associated response. @@ -13574,7 +14064,6 @@ Package Contents :type message_index: int - .. py:method:: export_chat_session(chat_session_id) Exports a chat session to an HTML file @@ -13583,7 +14072,6 @@ Package Contents :type chat_session_id: str - .. py:method:: rename_chat_session(chat_session_id, name) Renames a chat session with Data Science Co-pilot. @@ -13594,7 +14082,6 @@ Package Contents :type name: str - .. py:method:: suggest_abacus_apis(query, verbosity = 1, limit = 5, include_scores = False) Suggests several Abacus APIs that are most relevant to the supplied natural language query. @@ -13612,7 +14099,6 @@ Package Contents :rtype: list[AbacusApi] - .. py:method:: create_deployment_conversation(deployment_id, name, deployment_token = None, external_application_id = None) Creates a deployment conversation. @@ -13630,7 +14116,6 @@ Package Contents :rtype: DeploymentConversation - .. py:method:: delete_deployment_conversation(deployment_conversation_id, deployment_id = None, deployment_token = None) Delete a Deployment Conversation. @@ -13643,7 +14128,6 @@ Package Contents :type deployment_token: str - .. py:method:: clear_deployment_conversation(deployment_conversation_id = None, external_session_id = None, deployment_id = None, deployment_token = None, user_message_indices = None) Clear the message history of a Deployment Conversation. @@ -13660,7 +14144,6 @@ Package Contents :type user_message_indices: list - .. py:method:: set_deployment_conversation_feedback(deployment_conversation_id, message_index, is_useful = None, is_not_useful = None, feedback = None, feedback_type = None, deployment_id = None, deployment_token = None) Sets a deployment conversation message as useful or not useful @@ -13683,7 +14166,6 @@ Package Contents :type deployment_token: str - .. py:method:: rename_deployment_conversation(deployment_conversation_id, name, deployment_id = None, deployment_token = None) Rename a Deployment Conversation. @@ -13698,7 +14180,6 @@ Package Contents :type deployment_token: str - .. py:method:: create_app_user_group(name) Creates a new App User Group. This User Group is used to have permissions to access the external chatbots. @@ -13710,7 +14191,6 @@ Package Contents :rtype: AppUserGroup - .. py:method:: delete_app_user_group(user_group_id) Deletes an App User Group. @@ -13719,7 +14199,6 @@ Package Contents :type user_group_id: str - .. py:method:: invite_users_to_app_user_group(user_group_id, emails) Invite users to an App User Group. This method will send the specified email addresses an invitation link to join a specific user group. @@ -13736,7 +14215,6 @@ Package Contents :rtype: ExternalInvite - .. py:method:: add_users_to_app_user_group(user_group_id, user_emails) Adds users to a App User Group. @@ -13747,7 +14225,6 @@ Package Contents :type user_emails: list - .. py:method:: remove_users_from_app_user_group(user_group_id, user_emails) Removes users from an App User Group. @@ -13758,7 +14235,6 @@ Package Contents :type user_emails: list - .. py:method:: add_app_user_group_report_permission(user_group_id) Give the App User Group the permission to view all reports in the corresponding organization. @@ -13767,7 +14243,6 @@ Package Contents :type user_group_id: str - .. py:method:: remove_app_user_group_report_permission(user_group_id) Remove the App User Group's permission toview all reports in the corresponding organization. @@ -13776,7 +14251,6 @@ Package Contents :type user_group_id: str - .. py:method:: add_app_user_group_to_external_application(user_group_id, external_application_id) Adds a permission for an App User Group to access an External Application. @@ -13787,7 +14261,6 @@ Package Contents :type external_application_id: str - .. py:method:: remove_app_user_group_from_external_application(user_group_id, external_application_id) Removes a permission for an App User Group to access an External Application. @@ -13798,7 +14271,6 @@ Package Contents :type external_application_id: str - .. py:method:: create_external_application(deployment_id, name = None, description = None, logo = None, theme = None) Creates a new External Application from an existing ChatLLM Deployment. @@ -13818,7 +14290,6 @@ Package Contents :rtype: ExternalApplication - .. py:method:: update_external_application(external_application_id, name = None, description = None, theme = None, deployment_id = None, deployment_conversation_retention_hours = None, reset_retention_policy = False) Updates an External Application. @@ -13842,7 +14313,6 @@ Package Contents :rtype: ExternalApplication - .. py:method:: delete_external_application(external_application_id) Deletes an External Application. @@ -13851,7 +14321,6 @@ Package Contents :type external_application_id: str - .. py:method:: create_agent(project_id, function_source_code = None, agent_function_name = None, name = None, memory = None, package_requirements = None, description = None, enable_binary_input = False, evaluation_feature_group_id = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = AgentInterface.DEFAULT) Creates a new AI agent using the given agent workflow graph definition. @@ -13875,7 +14344,6 @@ Package Contents :rtype: Agent - .. py:method:: update_agent(model_id, function_source_code = None, agent_function_name = None, memory = None, package_requirements = None, description = None, enable_binary_input = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = None) Updates an existing AI Agent. A new version of the agent will be created and published. @@ -13895,7 +14363,6 @@ Package Contents :rtype: Agent - .. py:method:: evaluate_prompt(prompt = None, system_message = None, llm_name = None, max_tokens = None, temperature = 0.0, messages = None, response_type = None, json_response_schema = None) Generate response to the prompt using the specified model. @@ -13921,7 +14388,6 @@ Package Contents :rtype: LlmResponse - .. py:method:: render_feature_groups_for_llm(feature_group_ids, token_budget = None, include_definition = True) Encode feature groups as language model inputs. @@ -13934,8 +14400,7 @@ Package Contents :type include_definition: bool :returns: LLM input object comprising of information about the feature groups with given IDs. - :rtype: LlmInput - + :rtype: list[LlmInput] .. py:method:: generate_code_for_data_query_using_llm(query, feature_group_ids = None, external_database_schemas = None, prompt_context = None, llm_name = None, temperature = None, sql_dialect = 'Spark') @@ -13961,7 +14426,6 @@ Package Contents :rtype: LlmGeneratedCode - .. py:method:: extract_data_using_llm(field_descriptors, document_id = None, document_text = None, llm_name = None) Extract fields from a document using a large language model. @@ -13979,7 +14443,6 @@ Package Contents :rtype: ExtractedFields - .. py:method:: search_web_for_llm(queries, search_providers = None, max_results = 1, safe = True, fetch_content = False, max_page_tokens = 8192, convert_to_markdown = True) Access web search providers to fetch content related to the queries for use in large language model inputs. @@ -14009,7 +14472,6 @@ Package Contents :rtype: WebSearchResponse - .. py:method:: construct_agent_conversation_messages_for_llm(current_message = None, current_doc_ids = None, include_history = True, include_document_contents = True, deployment_conversation_id = None, external_session_id = None, max_document_words = None) Returns conversation history in a format for LLM calls. @@ -14033,7 +14495,6 @@ Package Contents :rtype: ChatMessage - .. py:method:: get_llm_app_response(llm_app_name, prompt) Queries the specified LLM App to generate a response to the prompt. LLM Apps are LLMs tailored to achieve a specific task like code generation for a specific service's API. @@ -14047,7 +14508,6 @@ Package Contents :rtype: LlmResponse - .. py:method:: create_document_retriever(project_id, name, feature_group_id, document_retriever_config = None) Returns a document retriever that stores embeddings for document chunks in a feature group. @@ -14068,7 +14528,6 @@ Package Contents :rtype: DocumentRetriever - .. py:method:: rename_document_retriever(document_retriever_id, name) Updates an existing document retriever. @@ -14082,7 +14541,6 @@ Package Contents :rtype: DocumentRetriever - .. py:method:: create_document_retriever_version(document_retriever_id, feature_group_id = None, document_retriever_config = None) Creates a document retriever version from the latest version of the feature group that the document retriever associated with. @@ -14098,7 +14556,6 @@ Package Contents :rtype: DocumentRetrieverVersion - .. py:method:: delete_document_retriever(vector_store_id) Delete a Document Retriever. @@ -14107,7 +14564,6 @@ Package Contents :type vector_store_id: str - .. py:method:: get_document_snippet(document_retriever_id, document_id, start_word_index = None, end_word_index = None) Get a snippet from documents in the document retriever. @@ -14125,7 +14581,6 @@ Package Contents :rtype: DocumentRetrieverLookupResult - .. py:method:: restart_document_retriever(document_retriever_id) Restart the document retriever if it is stopped. This will start the deployment of the document retriever, @@ -14137,7 +14592,6 @@ Package Contents :type document_retriever_id: str - .. py:method:: get_relevant_snippets(doc_ids = None, blobs = None, query = None, document_retriever_config = None, honor_sentence_boundary = True, num_retrieval_margin_words = None, max_words_per_snippet = None, max_snippets_per_document = None, start_word_index = None, end_word_index = None, including_bounding_boxes = False, text = None) Retrieves snippets relevant to a given query from specified documents. This function supports flexible input options, @@ -14176,8 +14630,8 @@ Package Contents .. py:exception:: ApiException(message, http_status, exception = None, request_id = None) - Bases: :py:obj:`Exception` + Bases: :py:obj:`Exception` Default ApiException raised by APIs @@ -14190,7 +14644,6 @@ Package Contents :param request_id: The request id :type request_id: str - .. py:method:: __str__() Return str(self). @@ -14199,6 +14652,7 @@ Package Contents .. py:class:: ClientOptions(exception_on_404 = True, server = DEFAULT_SERVER) + Options for configuring the ApiClient :param exception_on_404: If true, will raise an exception on a 404 from the server, else will return None. @@ -14209,8 +14663,8 @@ Package Contents .. py:class:: ReadOnlyClient(api_key = None, server = None, client_options = None, skip_version_check = False) - Bases: :py:obj:`BaseApiClient` + Bases: :py:obj:`BaseApiClient` Abacus.AI Read Only API Client. Only contains GET methods @@ -14223,7 +14677,6 @@ Package Contents :param skip_version_check: If true, will skip checking the server's current API version on initializing the client :type skip_version_check: bool - .. py:method:: list_api_keys() Lists all of the user's API keys @@ -14232,7 +14685,6 @@ Package Contents :rtype: list[ApiKey] - .. py:method:: list_organization_users() Retrieves a list of all users in the organization, including pending users who have been invited. @@ -14241,7 +14693,6 @@ Package Contents :rtype: list[User] - .. py:method:: describe_user() Retrieve the current user's information, such as their name, email address, and admin status. @@ -14250,7 +14701,6 @@ Package Contents :rtype: User - .. py:method:: list_organization_groups() Lists all Organizations Groups @@ -14259,7 +14709,6 @@ Package Contents :rtype: list[OrganizationGroup] - .. py:method:: describe_organization_group(organization_group_id) Returns the specific organization group passed in by the user. @@ -14271,7 +14720,6 @@ Package Contents :rtype: OrganizationGroup - .. py:method:: describe_webhook(webhook_id) Describe the webhook with a given ID. @@ -14283,7 +14731,6 @@ Package Contents :rtype: Webhook - .. py:method:: list_deployment_webhooks(deployment_id) List all the webhooks attached to a given deployment. @@ -14295,7 +14742,6 @@ Package Contents :rtype: list[Webhook] - .. py:method:: list_use_cases() Retrieves a list of all use cases with descriptions. Use the given mappings to specify a use case when needed. @@ -14304,7 +14750,6 @@ Package Contents :rtype: list[UseCase] - .. py:method:: describe_problem_type(problem_type) Describes a problem type @@ -14316,7 +14761,6 @@ Package Contents :rtype: ProblemType - .. py:method:: describe_use_case_requirements(use_case) This API call returns the feature requirements for a specified use case. @@ -14328,7 +14772,6 @@ Package Contents :rtype: list[UseCaseRequirements] - .. py:method:: describe_project(project_id) Returns a description of a project. @@ -14340,7 +14783,6 @@ Package Contents :rtype: Project - .. py:method:: list_projects(limit = 100, start_after_id = None) Retrieves a list of all projects in the current organization. @@ -14354,7 +14796,6 @@ Package Contents :rtype: list[Project] - .. py:method:: get_project_feature_group_config(feature_group_id, project_id) Gets a feature group's project config @@ -14368,7 +14809,6 @@ Package Contents :rtype: ProjectConfig - .. py:method:: validate_project(project_id, feature_group_ids = None) Validates that the specified project has all required feature group types for its use case and that all required feature columns are set. @@ -14382,7 +14822,6 @@ Package Contents :rtype: ProjectValidation - .. py:method:: infer_feature_mappings(project_id, feature_group_id) Infer the feature mappings for the feature group in the project based on the problem type. @@ -14396,7 +14835,6 @@ Package Contents :rtype: InferredFeatureMappings - .. py:method:: verify_and_describe_annotation(feature_group_id, feature_name = None, doc_id = None, feature_group_row_identifier = None) Get the latest annotation entry for a given feature group, feature, and document along with verification information. @@ -14414,7 +14852,6 @@ Package Contents :rtype: AnnotationEntry - .. py:method:: get_annotations_status(feature_group_id, feature_name = None, check_for_materialization = False) Get the status of the annotations for a given feature group and feature. @@ -14430,7 +14867,6 @@ Package Contents :rtype: AnnotationsStatus - .. py:method:: get_feature_group_schema(feature_group_id, project_id = None) Returns a schema for a given FeatureGroup in a project. @@ -14444,7 +14880,6 @@ Package Contents :rtype: list[Feature] - .. py:method:: get_point_in_time_feature_group_creation_options() Returns the options that can be used to generate PIT features. @@ -14453,7 +14888,6 @@ Package Contents :rtype: list[GeneratedPitFeatureConfigOption] - .. py:method:: describe_feature_group(feature_group_id) Describe a Feature Group. @@ -14465,7 +14899,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: describe_feature_group_by_table_name(table_name) Describe a Feature Group by its table name. @@ -14477,7 +14910,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: list_feature_groups(limit = 100, start_after_id = None, feature_group_template_id = None, is_including_detached_from_template = False) List all the feature groups @@ -14495,7 +14927,6 @@ Package Contents :rtype: list[FeatureGroup] - .. py:method:: describe_project_feature_group(project_id, feature_group_id) Describe a feature group associated with a project @@ -14509,7 +14940,6 @@ Package Contents :rtype: ProjectFeatureGroup - .. py:method:: list_project_feature_groups(project_id, filter_feature_group_use = None, limit = 100, start_after_id = None) List all the feature groups associated with a project @@ -14527,7 +14957,6 @@ Package Contents :rtype: list[ProjectFeatureGroup] - .. py:method:: list_python_function_feature_groups(name, limit = 100) List all the feature groups associated with a python function. @@ -14541,7 +14970,6 @@ Package Contents :rtype: list[FeatureGroup] - .. py:method:: get_execute_feature_group_operation_result_part_count(feature_group_operation_run_id) Gets the number of parts in the result of the execution of fg operation @@ -14550,7 +14978,6 @@ Package Contents :type feature_group_operation_run_id: str - .. py:method:: download_execute_feature_group_operation_result_part_chunk(feature_group_operation_run_id, part, offset = 0, chunk_size = 10485760) Downloads a chunk of the result of the execution of feature group operation @@ -14565,7 +14992,6 @@ Package Contents :type chunk_size: int - .. py:method:: get_feature_group_version_export_download_url(feature_group_export_id) Get a link to download the feature group version. @@ -14577,7 +15003,6 @@ Package Contents :rtype: FeatureGroupExportDownloadUrl - .. py:method:: describe_feature_group_export(feature_group_export_id) A feature group export @@ -14589,7 +15014,6 @@ Package Contents :rtype: FeatureGroupExport - .. py:method:: list_feature_group_exports(feature_group_id) Lists all of the feature group exports for the feature group @@ -14601,7 +15025,6 @@ Package Contents :rtype: list[FeatureGroupExport] - .. py:method:: get_feature_group_export_connector_errors(feature_group_export_id) Returns a stream containing the write errors of the feature group export database connection, if any writes failed to the database connector. @@ -14610,7 +15033,6 @@ Package Contents :type feature_group_export_id: str - .. py:method:: list_feature_group_modifiers(feature_group_id) List the users who can modify a given feature group. @@ -14622,7 +15044,6 @@ Package Contents :rtype: ModificationLockInfo - .. py:method:: get_materialization_logs(feature_group_version, stdout = False, stderr = False) Returns logs for a materialized feature group version. @@ -14638,7 +15059,6 @@ Package Contents :rtype: FunctionLogs - .. py:method:: list_feature_group_versions(feature_group_id, limit = 100, start_after_version = None) Retrieves a list of all feature group versions for the specified feature group. @@ -14654,7 +15074,6 @@ Package Contents :rtype: list[FeatureGroupVersion] - .. py:method:: describe_feature_group_version(feature_group_version) Describe a feature group version. @@ -14666,7 +15085,6 @@ Package Contents :rtype: FeatureGroupVersion - .. py:method:: get_feature_group_version_metrics(feature_group_version, selected_columns = None, include_charts = False, include_statistics = True) Get metrics for a specific feature group version. @@ -14684,7 +15102,6 @@ Package Contents :rtype: DataMetrics - .. py:method:: get_feature_group_version_logs(feature_group_version) Retrieves the feature group materialization logs. @@ -14696,7 +15113,6 @@ Package Contents :rtype: FeatureGroupVersionLogs - .. py:method:: describe_feature_group_template(feature_group_template_id) Describe a Feature Group Template. @@ -14708,7 +15124,6 @@ Package Contents :rtype: FeatureGroupTemplate - .. py:method:: list_feature_group_templates(limit = 100, start_after_id = None, feature_group_id = None, should_include_system_templates = False) List feature group templates, optionally scoped by the feature group that created the templates. @@ -14726,7 +15141,6 @@ Package Contents :rtype: list[FeatureGroupTemplate] - .. py:method:: list_project_feature_group_templates(project_id, limit = 100, start_after_id = None, should_include_all_system_templates = False) List feature group templates for feature groups associated with the project. @@ -14744,7 +15158,6 @@ Package Contents :rtype: list[FeatureGroupTemplate] - .. py:method:: suggest_feature_group_template_for_feature_group(feature_group_id) Suggest values for a feature gruop template, based on a feature group. @@ -14756,7 +15169,6 @@ Package Contents :rtype: FeatureGroupTemplate - .. py:method:: get_dataset_schema(dataset_id) Retrieves the column schema of a dataset. @@ -14768,7 +15180,6 @@ Package Contents :rtype: list[DatasetColumn] - .. py:method:: set_dataset_database_connector_config(dataset_id, database_connector_id, object_name = None, columns = None, query_arguments = None, sql_query = None) Sets database connector config for a dataset. This method is currently only supported for streaming datasets. @@ -14787,7 +15198,6 @@ Package Contents :type sql_query: str - .. py:method:: get_dataset_version_metrics(dataset_version, selected_columns = None, include_charts = False, include_statistics = True) Get metrics for a specific dataset version. @@ -14805,7 +15215,6 @@ Package Contents :rtype: DataMetrics - .. py:method:: get_file_connector_instructions(bucket, write_permission = False) Retrieves verification information to create a data connector to a cloud storage bucket. @@ -14819,7 +15228,6 @@ Package Contents :rtype: FileConnectorInstructions - .. py:method:: list_database_connectors() Retrieves a list of all database connectors along with their associated attributes. @@ -14828,7 +15236,6 @@ Package Contents :rtype: list[DatabaseConnector] - .. py:method:: list_file_connectors() Retrieves a list of all connected services in the organization and their current verification status. @@ -14837,7 +15244,6 @@ Package Contents :rtype: list[FileConnector] - .. py:method:: list_database_connector_objects(database_connector_id, fetch_raw_data = False) Lists querable objects in the database connector. @@ -14848,7 +15254,6 @@ Package Contents :type fetch_raw_data: bool - .. py:method:: get_database_connector_object_schema(database_connector_id, object_name = None, fetch_raw_data = False) Get the schema of an object in an database connector. @@ -14864,7 +15269,6 @@ Package Contents :rtype: DatabaseConnectorSchema - .. py:method:: query_database_connector(database_connector_id, query) Runs a query in the specified database connector. @@ -14875,7 +15279,6 @@ Package Contents :type query: str - .. py:method:: list_application_connectors() Retrieves a list of all application connectors along with their associated attributes. @@ -14884,7 +15287,6 @@ Package Contents :rtype: list[ApplicationConnector] - .. py:method:: list_application_connector_objects(application_connector_id) Lists querable objects in the application connector. @@ -14893,7 +15295,6 @@ Package Contents :type application_connector_id: str - .. py:method:: list_streaming_connectors() Retrieves a list of all streaming connectors along with their corresponding attributes. @@ -14902,7 +15303,6 @@ Package Contents :rtype: list[StreamingConnector] - .. py:method:: list_streaming_tokens() Retrieves a list of all streaming tokens. @@ -14911,7 +15311,6 @@ Package Contents :rtype: list[StreamingAuthToken] - .. py:method:: get_recent_feature_group_streamed_data(feature_group_id) Returns recently streamed data to a streaming feature group. @@ -14920,7 +15319,6 @@ Package Contents :type feature_group_id: str - .. py:method:: list_uploads() Lists all pending uploads @@ -14929,7 +15327,6 @@ Package Contents :rtype: list[Upload] - .. py:method:: describe_upload(upload_id) Retrieves the current upload status (complete or inspecting) and the list of file parts uploaded for a specified dataset upload. @@ -14941,7 +15338,6 @@ Package Contents :rtype: Upload - .. py:method:: list_datasets(limit = 100, start_after_id = None, exclude_streaming = False) Retrieves a list of all datasets in the organization. @@ -14957,7 +15353,6 @@ Package Contents :rtype: list[Dataset] - .. py:method:: describe_dataset(dataset_id) Retrieves a full description of the specified dataset, with attributes such as its ID, name, source type, etc. @@ -14969,7 +15364,6 @@ Package Contents :rtype: Dataset - .. py:method:: describe_dataset_version(dataset_version) Retrieves a full description of the specified dataset version, including its ID, name, source type, and other attributes. @@ -14981,7 +15375,6 @@ Package Contents :rtype: DatasetVersion - .. py:method:: list_dataset_versions(dataset_id, limit = 100, start_after_version = None) Retrieves a list of all dataset versions for the specified dataset. @@ -14997,7 +15390,6 @@ Package Contents :rtype: list[DatasetVersion] - .. py:method:: get_dataset_version_logs(dataset_version) Retrieves the dataset import logs. @@ -15009,7 +15401,6 @@ Package Contents :rtype: DatasetVersionLogs - .. py:method:: get_docstore_document(doc_id) Return a document store document by id. @@ -15018,7 +15409,6 @@ Package Contents :type doc_id: str - .. py:method:: get_docstore_image(doc_id, max_width = None, max_height = None) Return a document store image by id. @@ -15031,7 +15421,6 @@ Package Contents :type max_height: int - .. py:method:: describe_train_test_data_split_feature_group(model_id) Get the train and test data split for a trained model by its unique identifier. This is only supported for models with custom algorithms. @@ -15043,7 +15432,6 @@ Package Contents :rtype: FeatureGroup - .. py:method:: describe_train_test_data_split_feature_group_version(model_version) Get the train and test data split for a trained model by model version. This is only supported for models with custom algorithms. @@ -15055,7 +15443,6 @@ Package Contents :rtype: FeatureGroupVersion - .. py:method:: list_models(project_id) Retrieves the list of models in the specified project. @@ -15067,7 +15454,6 @@ Package Contents :rtype: list[Model] - .. py:method:: describe_model(model_id) Retrieves a full description of the specified model. @@ -15079,7 +15465,6 @@ Package Contents :rtype: Model - .. py:method:: get_model_metrics(model_id, model_version = None, return_graphs = False, validation = False) Retrieves metrics for all the algorithms trained in this model version. @@ -15100,7 +15485,6 @@ Package Contents :rtype: ModelMetrics - .. py:method:: get_feature_group_schemas_for_model_version(model_version) Gets the schema (including feature mappings) for all feature groups used in the model version. @@ -15112,7 +15496,6 @@ Package Contents :rtype: list[ModelVersionFeatureGroupSchema] - .. py:method:: list_model_versions(model_id, limit = 100, start_after_version = None) Retrieves a list of versions for a given model. @@ -15128,7 +15511,6 @@ Package Contents :rtype: list[ModelVersion] - .. py:method:: describe_model_version(model_version) Retrieves a full description of the specified model version. @@ -15140,7 +15522,6 @@ Package Contents :rtype: ModelVersion - .. py:method:: get_feature_importance_by_model_version(model_version) Gets the feature importance calculated by various methods for the model. @@ -15152,7 +15533,6 @@ Package Contents :rtype: FeatureImportance - .. py:method:: get_training_data_logs(model_version) Retrieves the data preparation logs during model training. @@ -15164,7 +15544,6 @@ Package Contents :rtype: list[DataPrepLogs] - .. py:method:: get_training_logs(model_version, stdout = False, stderr = False) Returns training logs for the model. @@ -15180,7 +15559,6 @@ Package Contents :rtype: FunctionLogs - .. py:method:: describe_model_artifacts_export(model_artifacts_export_id) Get the description and status of the model artifacts export. @@ -15192,7 +15570,6 @@ Package Contents :rtype: ModelArtifactsExport - .. py:method:: list_model_artifacts_exports(model_id, limit = 25) List all the model artifacts exports. @@ -15206,7 +15583,6 @@ Package Contents :rtype: list[ModelArtifactsExport] - .. py:method:: list_model_monitors(project_id) Retrieves the list of model monitors in the specified project. @@ -15218,7 +15594,6 @@ Package Contents :rtype: list[ModelMonitor] - .. py:method:: describe_model_monitor(model_monitor_id) Retrieves a full description of the specified model monitor. @@ -15230,7 +15605,6 @@ Package Contents :rtype: ModelMonitor - .. py:method:: get_prediction_drift(model_monitor_version) Gets the label and prediction drifts for a model monitor. @@ -15242,7 +15616,6 @@ Package Contents :rtype: DriftDistributions - .. py:method:: get_model_monitor_summary(model_monitor_id) Gets the summary of a model monitor across versions. @@ -15254,7 +15627,6 @@ Package Contents :rtype: ModelMonitorSummary - .. py:method:: list_model_monitor_versions(model_monitor_id, limit = 100, start_after_version = None) Retrieves a list of versions for a given model monitor. @@ -15270,7 +15642,6 @@ Package Contents :rtype: list[ModelMonitorVersion] - .. py:method:: describe_model_monitor_version(model_monitor_version) Retrieves a full description of the specified model monitor version. @@ -15282,7 +15653,6 @@ Package Contents :rtype: ModelMonitorVersion - .. py:method:: model_monitor_version_metric_data(model_monitor_version, metric_type, actual_values_to_detail = None) Provides the data needed for decile metrics associated with the model monitor. @@ -15298,7 +15668,6 @@ Package Contents :rtype: ModelMonitorVersionMetricData - .. py:method:: list_organization_model_monitors(only_starred = False) Gets a list of Model Monitors for an organization. @@ -15310,7 +15679,6 @@ Package Contents :rtype: list[ModelMonitor] - .. py:method:: get_model_monitor_chart_from_organization(chart_type, limit = 15) Gets a list of model monitor summaries across monitors for an organization. @@ -15324,7 +15692,6 @@ Package Contents :rtype: list[ModelMonitorSummaryFromOrg] - .. py:method:: get_model_monitor_summary_from_organization() Gets a consolidated summary of model monitors for an organization. @@ -15333,7 +15700,6 @@ Package Contents :rtype: list[ModelMonitorOrgSummary] - .. py:method:: list_eda(project_id) Retrieves the list of Exploratory Data Analysis (EDA) in the specified project. @@ -15345,7 +15711,6 @@ Package Contents :rtype: list[Eda] - .. py:method:: describe_eda(eda_id) Retrieves a full description of the specified EDA object. @@ -15357,7 +15722,6 @@ Package Contents :rtype: Eda - .. py:method:: list_eda_versions(eda_id, limit = 100, start_after_version = None) Retrieves a list of versions for a given EDA object. @@ -15373,7 +15737,6 @@ Package Contents :rtype: list[EdaVersion] - .. py:method:: describe_eda_version(eda_version) Retrieves a full description of the specified EDA version. @@ -15385,7 +15748,6 @@ Package Contents :rtype: EdaVersion - .. py:method:: get_eda_collinearity(eda_version) Gets the Collinearity between all features for the Exploratory Data Analysis. @@ -15397,7 +15759,6 @@ Package Contents :rtype: EdaCollinearity - .. py:method:: get_eda_data_consistency(eda_version, transformation_feature = None) Gets the data consistency for the Exploratory Data Analysis. @@ -15411,7 +15772,6 @@ Package Contents :rtype: EdaDataConsistency - .. py:method:: get_collinearity_for_feature(eda_version, feature_name = None) Gets the Collinearity for the given feature from the Exploratory Data Analysis. @@ -15425,7 +15785,6 @@ Package Contents :rtype: EdaFeatureCollinearity - .. py:method:: get_feature_association(eda_version, reference_feature_name, test_feature_name) Gets the Feature Association for the given features from the feature group version within the eda_version. @@ -15441,7 +15800,6 @@ Package Contents :rtype: EdaFeatureAssociation - .. py:method:: get_eda_forecasting_analysis(eda_version) Gets the Forecasting analysis for the Exploratory Data Analysis. @@ -15453,7 +15811,6 @@ Package Contents :rtype: EdaForecastingAnalysis - .. py:method:: list_holdout_analysis(project_id, model_id = None) List holdout analyses for a project. Optionally, filter by model. @@ -15467,7 +15824,6 @@ Package Contents :rtype: list[HoldoutAnalysis] - .. py:method:: describe_holdout_analysis(holdout_analysis_id) Get a holdout analysis. @@ -15479,7 +15835,6 @@ Package Contents :rtype: HoldoutAnalysis - .. py:method:: list_holdout_analysis_versions(holdout_analysis_id) List holdout analysis versions for a holdout analysis. @@ -15491,7 +15846,6 @@ Package Contents :rtype: list[HoldoutAnalysisVersion] - .. py:method:: describe_holdout_analysis_version(holdout_analysis_version, get_metrics = False) Get a holdout analysis version. @@ -15505,7 +15859,6 @@ Package Contents :rtype: HoldoutAnalysisVersion - .. py:method:: describe_monitor_alert(monitor_alert_id) Describes a given monitor alert id @@ -15517,7 +15870,6 @@ Package Contents :rtype: MonitorAlert - .. py:method:: describe_monitor_alert_version(monitor_alert_version) Describes a given monitor alert version id @@ -15529,7 +15881,6 @@ Package Contents :rtype: MonitorAlertVersion - .. py:method:: list_monitor_alerts_for_monitor(model_monitor_id = None, realtime_monitor_id = None) Retrieves the list of monitor alerts for a specified monitor. One of the model_monitor_id or realtime_monitor_id is required but not both. @@ -15543,7 +15894,6 @@ Package Contents :rtype: list[MonitorAlert] - .. py:method:: list_monitor_alert_versions_for_monitor_version(model_monitor_version) Retrieves the list of monitor alert versions for a specified monitor instance. @@ -15555,7 +15905,6 @@ Package Contents :rtype: list[MonitorAlertVersion] - .. py:method:: get_drift_for_feature(model_monitor_version, feature_name, nested_feature_name = None) Gets the feature drift associated with a single feature in an output feature group from a prediction. @@ -15571,7 +15920,6 @@ Package Contents :rtype: FeatureDistribution - .. py:method:: get_outliers_for_feature(model_monitor_version, feature_name = None, nested_feature_name = None) Gets a list of outliers measured by a single feature (or overall) in an output feature group from a prediction. @@ -15584,7 +15932,6 @@ Package Contents :type nested_feature_name: str - .. py:method:: describe_prediction_operator(prediction_operator_id) Describe an existing prediction operator. @@ -15596,7 +15943,6 @@ Package Contents :rtype: PredictionOperator - .. py:method:: list_prediction_operators(project_id) List all the prediction operators inside a project. @@ -15608,7 +15954,6 @@ Package Contents :rtype: list[PredictionOperator] - .. py:method:: list_prediction_operator_versions(prediction_operator_id) List all the prediction operator versions for a prediction operator. @@ -15620,7 +15965,6 @@ Package Contents :rtype: list[PredictionOperatorVersion] - .. py:method:: describe_deployment(deployment_id) Retrieves a full description of the specified deployment. @@ -15632,7 +15976,6 @@ Package Contents :rtype: Deployment - .. py:method:: list_deployments(project_id) Retrieves a list of all deployments in the specified project. @@ -15644,7 +15987,6 @@ Package Contents :rtype: list[Deployment] - .. py:method:: list_deployment_tokens(project_id) Retrieves a list of all deployment tokens associated with the specified project. @@ -15656,7 +15998,6 @@ Package Contents :rtype: list[DeploymentAuthToken] - .. py:method:: get_api_endpoint(deployment_token = None, deployment_id = None, streaming_token = None, feature_group_id = None, model_id = None) Returns the API endpoint specific to an organization. This function can be utilized using either an API Key or a deployment ID and token for authentication. @@ -15676,7 +16017,6 @@ Package Contents :rtype: ApiEndpoint - .. py:method:: get_model_training_types_for_deployment(model_id, model_version = None, algorithm = None) Returns types of models that can be deployed for a given model instance ID. @@ -15692,7 +16032,6 @@ Package Contents :rtype: ModelTrainingTypeForDeployment - .. py:method:: list_deployment_alerts(deployment_id) List the monitor alerts associated with the deployment id. @@ -15704,7 +16043,6 @@ Package Contents :rtype: list[MonitorAlert] - .. py:method:: list_realtime_monitors(project_id) List the real-time monitors associated with the deployment id. @@ -15716,7 +16054,6 @@ Package Contents :rtype: list[RealtimeMonitor] - .. py:method:: describe_realtime_monitor(realtime_monitor_id) Get the real-time monitor associated with the real-time monitor id. @@ -15728,7 +16065,6 @@ Package Contents :rtype: RealtimeMonitor - .. py:method:: describe_refresh_policy(refresh_policy_id) Retrieve a single refresh policy @@ -15740,7 +16076,6 @@ Package Contents :rtype: RefreshPolicy - .. py:method:: describe_refresh_pipeline_run(refresh_pipeline_run_id) Retrieve a single refresh pipeline run @@ -15752,7 +16087,6 @@ Package Contents :rtype: RefreshPipelineRun - .. py:method:: list_refresh_policies(project_id = None, dataset_ids = [], feature_group_id = None, model_ids = [], deployment_ids = [], batch_prediction_ids = [], model_monitor_ids = [], notebook_ids = []) List the refresh policies for the organization. If no filters are specified, all refresh policies are returned. @@ -15778,7 +16112,6 @@ Package Contents :rtype: list[RefreshPolicy] - .. py:method:: list_refresh_pipeline_runs(refresh_policy_id) List the the times that the refresh policy has been run @@ -15790,7 +16123,6 @@ Package Contents :rtype: list[RefreshPipelineRun] - .. py:method:: download_batch_prediction_result_chunk(batch_prediction_version, offset = 0, chunk_size = 10485760) Returns a stream containing the batch prediction results. @@ -15803,7 +16135,6 @@ Package Contents :type chunk_size: int - .. py:method:: get_batch_prediction_connector_errors(batch_prediction_version) Returns a stream containing the batch prediction database connection write errors, if any writes failed for the specified batch prediction job. @@ -15812,7 +16143,6 @@ Package Contents :type batch_prediction_version: str - .. py:method:: list_batch_predictions(project_id) Retrieves a list of batch predictions in the project. @@ -15824,7 +16154,6 @@ Package Contents :rtype: list[BatchPrediction] - .. py:method:: describe_batch_prediction(batch_prediction_id) Describe the batch prediction. @@ -15836,7 +16165,6 @@ Package Contents :rtype: BatchPrediction - .. py:method:: list_batch_prediction_versions(batch_prediction_id, limit = 100, start_after_version = None) Retrieves a list of versions of a given batch prediction @@ -15852,7 +16180,6 @@ Package Contents :rtype: list[BatchPredictionVersion] - .. py:method:: describe_batch_prediction_version(batch_prediction_version) Describes a Batch Prediction Version. @@ -15864,7 +16191,6 @@ Package Contents :rtype: BatchPredictionVersion - .. py:method:: get_batch_prediction_version_logs(batch_prediction_version) Retrieves the batch prediction logs. @@ -15876,7 +16202,6 @@ Package Contents :rtype: BatchPredictionVersionLogs - .. py:method:: get_data(feature_group_id, primary_key = None, num_rows = None) Gets the feature group rows for online updatable feature groups. @@ -15896,7 +16221,6 @@ Package Contents :rtype: list[FeatureGroupRow] - .. py:method:: describe_python_function(name) Describe a Python Function. @@ -15908,7 +16232,6 @@ Package Contents :rtype: PythonFunction - .. py:method:: list_python_functions(function_type = 'FEATURE_GROUP') List all python functions within the organization. @@ -15920,7 +16243,6 @@ Package Contents :rtype: list[PythonFunction] - .. py:method:: list_pipelines(project_id = None) Lists the pipelines for an organization or a project @@ -15932,7 +16254,6 @@ Package Contents :rtype: list[Pipeline] - .. py:method:: describe_pipeline_version(pipeline_version) Describes a specified pipeline version @@ -15944,7 +16265,6 @@ Package Contents :rtype: PipelineVersion - .. py:method:: describe_pipeline_step(pipeline_step_id) Deletes a step from a pipeline. @@ -15956,7 +16276,6 @@ Package Contents :rtype: PipelineStep - .. py:method:: describe_pipeline_step_by_name(pipeline_id, step_name) Describes a pipeline step by the step name. @@ -15970,7 +16289,6 @@ Package Contents :rtype: PipelineStep - .. py:method:: describe_pipeline_step_version(pipeline_step_version) Describes a pipeline step version. @@ -15982,7 +16300,6 @@ Package Contents :rtype: PipelineStepVersion - .. py:method:: list_pipeline_version_logs(pipeline_version) Gets the logs for the steps in a given pipeline version. @@ -15994,7 +16311,6 @@ Package Contents :rtype: PipelineVersionLogs - .. py:method:: get_step_version_logs(pipeline_step_version) Gets the logs for a given step version. @@ -16006,7 +16322,6 @@ Package Contents :rtype: PipelineStepVersionLogs - .. py:method:: describe_graph_dashboard(graph_dashboard_id) Describes a given graph dashboard. @@ -16018,7 +16333,6 @@ Package Contents :rtype: GraphDashboard - .. py:method:: list_graph_dashboards(project_id = None) Lists the graph dashboards for a project @@ -16030,7 +16344,6 @@ Package Contents :rtype: list[GraphDashboard] - .. py:method:: describe_graph_for_dashboard(graph_reference_id) Describes a python plot to a graph dashboard @@ -16042,7 +16355,6 @@ Package Contents :rtype: PythonPlotFunction - .. py:method:: describe_algorithm(algorithm) Retrieves a full description of the specified algorithm. @@ -16054,7 +16366,6 @@ Package Contents :rtype: Algorithm - .. py:method:: list_algorithms(problem_type = None, project_id = None) List all custom algorithms, with optional filtering on Problem Type and Project ID @@ -16068,7 +16379,6 @@ Package Contents :rtype: list[Algorithm] - .. py:method:: describe_custom_loss_function(name) Retrieve a full description of a previously registered custom loss function. @@ -16080,7 +16390,6 @@ Package Contents :rtype: CustomLossFunction - .. py:method:: list_custom_loss_functions(name_prefix = None, loss_function_type = None) Retrieves a list of registered custom loss functions and their descriptions. @@ -16094,7 +16403,6 @@ Package Contents :rtype: CustomLossFunction - .. py:method:: describe_custom_metric(name) Retrieves a full description of a previously registered custom metric function. @@ -16106,7 +16414,6 @@ Package Contents :rtype: CustomMetric - .. py:method:: describe_custom_metric_version(custom_metric_version) Describes a given custom metric version @@ -16118,7 +16425,6 @@ Package Contents :rtype: CustomMetricVersion - .. py:method:: list_custom_metrics(name_prefix = None, problem_type = None) Retrieves a list of registered custom metrics. @@ -16132,7 +16438,6 @@ Package Contents :rtype: list[CustomMetric] - .. py:method:: describe_module(name) Retrieves a full description of the specified module. @@ -16144,7 +16449,6 @@ Package Contents :rtype: Module - .. py:method:: list_modules() List all the modules @@ -16153,7 +16457,6 @@ Package Contents :rtype: list[Module] - .. py:method:: get_organization_secret(secret_key) Gets a secret. @@ -16165,7 +16468,6 @@ Package Contents :rtype: OrganizationSecret - .. py:method:: list_organization_secrets() Lists all secrets for an organization. @@ -16174,7 +16476,6 @@ Package Contents :rtype: list[OrganizationSecret] - .. py:method:: query_feature_group_code_generator(query, language, project_id = None) Send a query to the feature group code generator tool to generate code for the query. @@ -16190,7 +16491,6 @@ Package Contents :rtype: LlmResponse - .. py:method:: get_natural_language_explanation(feature_group_id = None, feature_group_version = None, model_id = None) Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model @@ -16206,7 +16506,6 @@ Package Contents :rtype: NaturalLanguageExplanation - .. py:method:: generate_natural_language_explanation(feature_group_id = None, feature_group_version = None, model_id = None) Generates natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model @@ -16222,7 +16521,6 @@ Package Contents :rtype: NaturalLanguageExplanation - .. py:method:: get_chat_session(chat_session_id) Gets a chat session from Data Science Co-pilot. @@ -16234,7 +16532,6 @@ Package Contents :rtype: ChatSession - .. py:method:: list_chat_sessions(most_recent_per_project = False) Lists all chat sessions for the current user @@ -16246,8 +16543,7 @@ Package Contents :rtype: ChatSession - - .. py:method:: get_deployment_conversation(deployment_conversation_id = None, external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True) + .. py:method:: get_deployment_conversation(deployment_conversation_id = None, external_session_id = None, deployment_id = None, deployment_token = None, filter_intermediate_conversation_events = True, get_unused_document_uploads = False) Gets a deployment conversation. @@ -16261,12 +16557,13 @@ Package Contents :type deployment_token: str :param filter_intermediate_conversation_events: If true, intermediate conversation events will be filtered out. Default is true. :type filter_intermediate_conversation_events: bool + :param get_unused_document_uploads: If true, unused document uploads will be returned. Default is false. + :type get_unused_document_uploads: bool :returns: The deployment conversation. :rtype: DeploymentConversation - .. py:method:: list_deployment_conversations(deployment_id, external_application_id = None) Lists all conversations for the given deployment and current user. @@ -16280,7 +16577,6 @@ Package Contents :rtype: list[DeploymentConversation] - .. py:method:: export_deployment_conversation(deployment_conversation_id = None, external_session_id = None) Export a Deployment Conversation. @@ -16294,7 +16590,6 @@ Package Contents :rtype: DeploymentConversationExport - .. py:method:: get_app_user_group(user_group_id) Gets an App User Group. @@ -16306,7 +16601,6 @@ Package Contents :rtype: AppUserGroup - .. py:method:: describe_external_application(external_application_id) Describes an External Application. @@ -16318,7 +16612,6 @@ Package Contents :rtype: ExternalApplication - .. py:method:: list_external_applications() Lists External Applications in an organization. @@ -16327,7 +16620,6 @@ Package Contents :rtype: list[ExternalApplication] - .. py:method:: download_agent_attachment(deployment_id, attachment_id) Return an agent attachment. @@ -16338,7 +16630,6 @@ Package Contents :type attachment_id: str - .. py:method:: describe_agent(agent_id) Retrieves a full description of the specified model. @@ -16350,7 +16641,6 @@ Package Contents :rtype: Agent - .. py:method:: describe_agent_version(agent_version) Retrieves a full description of the specified agent version. @@ -16362,7 +16652,6 @@ Package Contents :rtype: AgentVersion - .. py:method:: search_feature_groups(text, num_results = 10, project_id = None, feature_group_ids = None) Search feature groups based on text and filters. @@ -16380,7 +16669,6 @@ Package Contents :rtype: list[OrganizationSearchResult] - .. py:method:: list_agents(project_id) Retrieves the list of agents in the specified project. @@ -16392,7 +16680,6 @@ Package Contents :rtype: list[Agent] - .. py:method:: list_agent_versions(agent_id, limit = 100, start_after_version = None) List all versions of an agent. @@ -16408,7 +16695,6 @@ Package Contents :rtype: list[AgentVersion] - .. py:method:: list_llm_apps() Lists all available LLM Apps, which are LLMs tailored to achieve a specific task like code generation for a specific service's API. @@ -16417,7 +16703,6 @@ Package Contents :rtype: list[LlmApp] - .. py:method:: list_document_retrievers(project_id, limit = 100, start_after_id = None) List all the document retrievers. @@ -16433,7 +16718,6 @@ Package Contents :rtype: list[DocumentRetriever] - .. py:method:: describe_document_retriever(document_retriever_id) Describe a Document Retriever. @@ -16445,7 +16729,6 @@ Package Contents :rtype: DocumentRetriever - .. py:method:: describe_document_retriever_by_name(name) Describe a document retriever by its name. @@ -16457,7 +16740,6 @@ Package Contents :rtype: DocumentRetriever - .. py:method:: list_document_retriever_versions(document_retriever_id, limit = 100, start_after_version = None) List all the document retriever versions with a given ID. @@ -16473,7 +16755,6 @@ Package Contents :rtype: list[DocumentRetrieverVersion] - .. py:method:: describe_document_retriever_version(document_retriever_version) Describe a document retriever version. @@ -16488,17 +16769,18 @@ Package Contents .. py:data:: _request_context + + .. py:class:: PredictionClient(client_options = None) - Bases: :py:obj:`abacusai.client.BaseApiClient` + Bases: :py:obj:`abacusai.client.BaseApiClient` Abacus.AI Prediction API Client. Does not utilize authentication and only contains public prediction methods :param client_options: Optional API client configurations :type client_options: ClientOptions - .. py:method:: predict_raw(deployment_token, deployment_id, **kwargs) Raw interface for returning predictions from Plug and Play deployments. @@ -16511,7 +16793,6 @@ Package Contents :type \*\*kwargs: dict - .. py:method:: lookup_features(deployment_token, deployment_id, query_data, limit_results = None, result_columns = None) Returns the feature group deployed in the feature store project. @@ -16528,7 +16809,6 @@ Package Contents :type result_columns: list - .. py:method:: predict(deployment_token, deployment_id, query_data) Returns a prediction for Predictive Modeling @@ -16541,7 +16821,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_multiple(deployment_token, deployment_id, query_data) Returns a list of predictions for predictive modeling. @@ -16554,7 +16833,6 @@ Package Contents :type query_data: list - .. py:method:: predict_from_datasets(deployment_token, deployment_id, query_data) Returns a list of predictions for Predictive Modeling. @@ -16567,7 +16845,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_lead(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user being a lead based on their interaction with the service/product and their own attributes (e.g. income, assets, credit score, etc.). Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'user_id' mapped to mapping 'LEAD_ID' in our system). @@ -16584,7 +16861,6 @@ Package Contents :type explainer_type: str - .. py:method:: predict_churn(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user to churn out in response to their interactions with the item/product/service. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'churn_result' mapped to mapping 'CHURNED_YN' in our system). @@ -16601,7 +16877,6 @@ Package Contents :type explainer_type: str - .. py:method:: predict_takeover(deployment_token, deployment_id, query_data) Returns a probability for each class label associated with the types of fraud or a 'yes' or 'no' type label for the possibility of fraud. Note that the inputs to this method, wherever applicable, will be the column names in the dataset mapped to the column mappings in our system (e.g., column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -16614,7 +16889,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_fraud(deployment_token, deployment_id, query_data) Returns the probability of a transaction performed under a specific account being fraudulent or not. Note that the inputs to this method, wherever applicable, should be the column names in your dataset mapped to the column mappings in our system (e.g. column 'account_number' mapped to the mapping 'ACCOUNT_ID' in our system). @@ -16627,7 +16901,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_class(deployment_token, deployment_id, query_data, threshold = None, threshold_class = None, thresholds = None, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a classification prediction @@ -16654,7 +16927,6 @@ Package Contents :type explainer_type: str - .. py:method:: predict_target(deployment_token, deployment_id, query_data, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a prediction from a classification or regression model. Optionally, includes explanations. @@ -16675,7 +16947,6 @@ Package Contents :type explainer_type: str - .. py:method:: get_anomalies(deployment_token, deployment_id, threshold = None, histogram = False) Returns a list of anomalies from the training dataset. @@ -16690,7 +16961,6 @@ Package Contents :type histogram: bool - .. py:method:: get_timeseries_anomalies(deployment_token, deployment_id, start_timestamp = None, end_timestamp = None, query_data = None, get_all_item_data = False, series_ids = None) Returns a list of anomalous timestamps from the training dataset. @@ -16711,7 +16981,6 @@ Package Contents :type series_ids: list - .. py:method:: is_anomaly(deployment_token, deployment_id, query_data = None) Returns a list of anomaly attributes based on login information for a specified account. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -16724,7 +16993,6 @@ Package Contents :type query_data: dict - .. py:method:: get_event_anomaly_score(deployment_token, deployment_id, query_data = None) Returns an anomaly score for an event. @@ -16737,7 +17005,6 @@ Package Contents :type query_data: dict - .. py:method:: get_forecast(deployment_token, deployment_id, query_data, future_data = None, num_predictions = None, prediction_start = None, explain_predictions = False, explainer_type = None, get_item_data = False) Returns a list of forecasts for a given entity under the specified project deployment. Note that the inputs to the deployed model will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'holiday_yn' mapped to mapping 'FUTURE' in our system). @@ -16762,7 +17029,6 @@ Package Contents :type get_item_data: bool - .. py:method:: get_k_nearest(deployment_token, deployment_id, vector, k = None, distance = None, include_score = False, catalog_id = None) Returns the k nearest neighbors for the provided embedding vector. @@ -16783,7 +17049,6 @@ Package Contents :type catalog_id: str - .. py:method:: get_multiple_k_nearest(deployment_token, deployment_id, queries) Returns the k nearest neighbors for the queries provided. @@ -16796,7 +17061,6 @@ Package Contents :type queries: list - .. py:method:: get_labels(deployment_token, deployment_id, query_data, return_extracted_entities = False) Returns a list of scored labels for a document. @@ -16811,7 +17075,6 @@ Package Contents :type return_extracted_entities: bool - .. py:method:: get_entities_from_pdf(deployment_token, deployment_id, pdf = None, doc_id = None, return_extracted_features = False, verbose = False, save_extracted_features = None) Extracts text from the provided PDF and returns a list of recognized labels and their scores. @@ -16832,7 +17095,6 @@ Package Contents :type save_extracted_features: bool - .. py:method:: get_recommendations(deployment_token, deployment_id, query_data, num_items = None, page = None, exclude_item_ids = None, score_field = None, scaling_factors = None, restrict_items = None, exclude_items = None, explore_fraction = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of recommendations for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'time' mapped to mapping 'TIMESTAMP' in our system). @@ -16863,7 +17125,6 @@ Package Contents :type diversity_max_results_per_value: int - .. py:method:: get_personalized_ranking(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, scaling_factors = None) Returns a list of items with personalized promotions for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -16882,7 +17143,6 @@ Package Contents :type scaling_factors: list - .. py:method:: get_ranked_items(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, score_field = None, scaling_factors = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of re-ranked items for a selected user when a list of items is required to be reranked according to the user's preferences. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -16907,7 +17167,6 @@ Package Contents :type diversity_max_results_per_value: int - .. py:method:: get_related_items(deployment_token, deployment_id, query_data, num_items = None, page = None, scaling_factors = None, restrict_items = None, exclude_items = None) Returns a list of related items for a given item under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -16930,7 +17189,6 @@ Package Contents :type exclude_items: list - .. py:method:: get_chat_response(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False) Return a chat response which continues the conversation based on the input messages and search results. @@ -16959,7 +17217,6 @@ Package Contents :type ignore_documents: bool - .. py:method:: get_chat_response_with_binary_data(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a chat response which continues the conversation based on the input messages and search results. @@ -16990,7 +17247,6 @@ Package Contents :type attachments: None - .. py:method:: get_conversation_response(deployment_id, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, deployment_token = None, doc_infos = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -17025,7 +17281,6 @@ Package Contents :type doc_infos: list - .. py:method:: get_conversation_response_with_binary_data(deployment_id, deployment_token, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -17060,7 +17315,6 @@ Package Contents :type attachments: None - .. py:method:: get_search_results(deployment_token, deployment_id, query_data, num = 15) Return the most relevant search results to the search query from the uploaded documents. @@ -17075,7 +17329,6 @@ Package Contents :type num: int - .. py:method:: get_sentiment(deployment_token, deployment_id, document) Predicts sentiment on a document @@ -17088,7 +17341,6 @@ Package Contents :type document: str - .. py:method:: get_entailment(deployment_token, deployment_id, document) Predicts the classification of the document @@ -17101,7 +17353,6 @@ Package Contents :type document: str - .. py:method:: get_classification(deployment_token, deployment_id, document) Predicts the classification of the document @@ -17114,7 +17365,6 @@ Package Contents :type document: str - .. py:method:: get_summary(deployment_token, deployment_id, query_data) Returns a JSON of the predicted summary for the given document. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'text' mapped to mapping 'DOCUMENT' in our system). @@ -17127,7 +17377,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_language(deployment_token, deployment_id, query_data) Predicts the language of the text @@ -17140,7 +17389,6 @@ Package Contents :type query_data: str - .. py:method:: get_assignments(deployment_token, deployment_id, query_data, forced_assignments = None, solve_time_limit_seconds = None, include_all_assignments = False) Get all positive assignments that match a query. @@ -17159,7 +17407,6 @@ Package Contents :type include_all_assignments: bool - .. py:method:: get_alternative_assignments(deployment_token, deployment_id, query_data, add_constraints = None, solve_time_limit_seconds = None, best_alternate_only = False) Get alternative positive assignments for given query. Optimal assignments are ignored and the alternative assignments are returned instead. @@ -17178,7 +17425,6 @@ Package Contents :type best_alternate_only: bool - .. py:method:: check_constraints(deployment_token, deployment_id, query_data) Check for any constraints violated by the overrides. @@ -17191,7 +17437,6 @@ Package Contents :type query_data: dict - .. py:method:: predict_with_binary_data(deployment_token, deployment_id, blob) Make predictions for a given blob, e.g. image, audio @@ -17204,7 +17449,6 @@ Package Contents :type blob: io.TextIOBase - .. py:method:: describe_image(deployment_token, deployment_id, image, categories, top_n = None) Describe the similarity between an image and a list of categories. @@ -17221,7 +17465,6 @@ Package Contents :type top_n: int - .. py:method:: get_text_from_document(deployment_token, deployment_id, document = None, adjust_doc_orientation = False, save_predicted_pdf = False, save_extracted_features = False) Generate text from a document @@ -17240,7 +17483,6 @@ Package Contents :type save_extracted_features: bool - .. py:method:: transcribe_audio(deployment_token, deployment_id, audio) Transcribe the audio @@ -17253,7 +17495,6 @@ Package Contents :type audio: io.TextIOBase - .. py:method:: classify_image(deployment_token, deployment_id, image = None, doc_id = None) Classify an image. @@ -17268,7 +17509,6 @@ Package Contents :type doc_id: str - .. py:method:: classify_pdf(deployment_token, deployment_id, pdf = None) Returns a classification prediction from a PDF @@ -17281,7 +17521,6 @@ Package Contents :type pdf: io.TextIOBase - .. py:method:: get_cluster(deployment_token, deployment_id, query_data) Predicts the cluster for given data. @@ -17294,7 +17533,6 @@ Package Contents :type query_data: dict - .. py:method:: get_objects_from_image(deployment_token, deployment_id, image) Classify an image. @@ -17307,7 +17545,6 @@ Package Contents :type image: io.TextIOBase - .. py:method:: score_image(deployment_token, deployment_id, image) Score on image. @@ -17320,7 +17557,6 @@ Package Contents :type image: io.TextIOBase - .. py:method:: transfer_style(deployment_token, deployment_id, source_image, style_image) Change the source image to adopt the visual style from the style image. @@ -17335,7 +17571,6 @@ Package Contents :type style_image: io.TextIOBase - .. py:method:: generate_image(deployment_token, deployment_id, query_data) Generate an image from text prompt. @@ -17348,7 +17583,6 @@ Package Contents :type query_data: dict - .. py:method:: execute_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -17363,7 +17597,6 @@ Package Contents :type keyword_arguments: dict - .. py:method:: execute_conversation_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, regenerate = False, doc_infos = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -17386,7 +17619,6 @@ Package Contents :type doc_infos: list - .. py:method:: lookup_matches(deployment_token, deployment_id, data = None, filters = None, num = None, result_columns = None, max_words = None, num_retrieval_margin_words = None, max_words_per_chunk = None, score_multiplier_column = None, min_score = None, required_phrases = None, filter_clause = None, crowding_limits = None) Lookup document retrievers and return the matching documents from the document retriever deployed with given query. @@ -17429,7 +17661,6 @@ Package Contents :rtype: list[DocumentRetrieverLookupResult] - .. py:method:: get_completion(deployment_token, deployment_id, prompt) Returns the finetuned LLM generated completion of the prompt. @@ -17442,7 +17673,6 @@ Package Contents :type prompt: str - .. py:method:: execute_agent_with_binary_data(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, blobs = None) Executes a deployed AI agent function with binary data as inputs. @@ -17469,15 +17699,14 @@ Package Contents .. py:class:: StreamingClient(client_options = None) - Bases: :py:obj:`abacusai.client.BaseApiClient` + Bases: :py:obj:`abacusai.client.BaseApiClient` Abacus.AI Streaming API Client. Does not utilize authentication and only contains public streaming methods :param client_options: Optional API client configurations :type client_options: ClientOptions - .. py:method:: upsert_item_embeddings(streaming_token, model_id, item_id, vector, catalog_id = None) Upserts an embedding vector for an item id for a model_id. @@ -17494,7 +17723,6 @@ Package Contents :type catalog_id: str - .. py:method:: delete_item_embeddings(streaming_token, model_id, item_ids, catalog_id = None) Deletes KNN embeddings for a list of item IDs for a given model ID. @@ -17509,7 +17737,6 @@ Package Contents :type catalog_id: str - .. py:method:: upsert_multiple_item_embeddings(streaming_token, model_id, upserts, catalog_id = None) Upserts a knn embedding for multiple item ids for a model_id. @@ -17524,7 +17751,6 @@ Package Contents :type catalog_id: str - .. py:method:: append_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -17537,7 +17763,6 @@ Package Contents :type data: dict - .. py:method:: append_multiple_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -17552,6 +17777,7 @@ Package Contents .. py:data:: __version__ - :value: '1.3.2' + :value: '1.3.3' + diff --git a/docs/_sources/autoapi/abacusai/indexing_config/index.rst.txt b/docs/_sources/autoapi/abacusai/indexing_config/index.rst.txt index 2ea0d0571..a0cb36669 100644 --- a/docs/_sources/autoapi/abacusai/indexing_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/indexing_config/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.indexing_config -======================== +:py:mod:`abacusai.indexing_config` +================================== .. py:module:: abacusai.indexing_config -Classes -------- - -.. autoapisummary:: - - abacusai.indexing_config.AbstractApiClass - abacusai.indexing_config.IndexingConfig - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.indexing_config.IndexingConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: IndexingConfig(client, primaryKey=None, updateTimestampKey=None, lookupKeys=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The indexing config for a Feature Group @@ -43,13 +33,11 @@ Module Contents :param lookupKeys: A multi-key index. Cannot be used in conjuction with primary key. :type lookupKeys: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/inferred_database_column_to_feature_mappings/index.rst.txt b/docs/_sources/autoapi/abacusai/inferred_database_column_to_feature_mappings/index.rst.txt index c8cd05c93..f8b6017c9 100644 --- a/docs/_sources/autoapi/abacusai/inferred_database_column_to_feature_mappings/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/inferred_database_column_to_feature_mappings/index.rst.txt @@ -1,67 +1,26 @@ -abacusai.inferred_database_column_to_feature_mappings -===================================================== +:py:mod:`abacusai.inferred_database_column_to_feature_mappings` +=============================================================== .. py:module:: abacusai.inferred_database_column_to_feature_mappings -Classes -------- - -.. autoapisummary:: - - abacusai.inferred_database_column_to_feature_mappings.DatabaseColumnFeatureMapping - abacusai.inferred_database_column_to_feature_mappings.AbstractApiClass - abacusai.inferred_database_column_to_feature_mappings.InferredDatabaseColumnToFeatureMappings - - Module Contents --------------- -.. py:class:: DatabaseColumnFeatureMapping(client, databaseColumn=None, feature=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Mapping for export of feature group version to database column - - :param client: An authenticated API Client instance - :type client: ApiClient - :param databaseColumn: database column name - :type databaseColumn: str - :param feature: feature group column it has been matched to - :type feature: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.inferred_database_column_to_feature_mappings.InferredDatabaseColumnToFeatureMappings - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: InferredDatabaseColumnToFeatureMappings(client, databaseColumnToFeatureMappings={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Autocomplete mappings for database to connector columns @@ -70,13 +29,11 @@ Module Contents :param databaseColumnToFeatureMappings: Database columns feature mappings :type databaseColumnToFeatureMappings: DatabaseColumnFeatureMapping - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/inferred_feature_mappings/index.rst.txt b/docs/_sources/autoapi/abacusai/inferred_feature_mappings/index.rst.txt index a0a30f4fd..f9ebf2798 100644 --- a/docs/_sources/autoapi/abacusai/inferred_feature_mappings/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/inferred_feature_mappings/index.rst.txt @@ -1,67 +1,26 @@ -abacusai.inferred_feature_mappings -================================== +:py:mod:`abacusai.inferred_feature_mappings` +============================================ .. py:module:: abacusai.inferred_feature_mappings -Classes -------- - -.. autoapisummary:: - - abacusai.inferred_feature_mappings.FeatureMapping - abacusai.inferred_feature_mappings.AbstractApiClass - abacusai.inferred_feature_mappings.InferredFeatureMappings - - Module Contents --------------- -.. py:class:: FeatureMapping(client, featureMapping=None, featureName=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A description of the data use for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureMapping: The mapping of the feature. The possible values will be based on the project's use-case. See the (Use Case Documentation)[https://api.abacus.ai/app/help/useCases] for more details. - :type featureMapping: str - :param featureName: The unique name of the feature. - :type featureName: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.inferred_feature_mappings.InferredFeatureMappings - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: InferredFeatureMappings(client, error=None, featureMappings={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A description of the data use for a feature @@ -72,13 +31,11 @@ Module Contents :param featureMappings: The inferred feature mappings :type featureMappings: FeatureMapping - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/item_statistics/index.rst.txt b/docs/_sources/autoapi/abacusai/item_statistics/index.rst.txt index 616a76216..7a7c6cde2 100644 --- a/docs/_sources/autoapi/abacusai/item_statistics/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/item_statistics/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.item_statistics -======================== +:py:mod:`abacusai.item_statistics` +================================== .. py:module:: abacusai.item_statistics -Classes -------- - -.. autoapisummary:: - - abacusai.item_statistics.AbstractApiClass - abacusai.item_statistics.ItemStatistics - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.item_statistics.ItemStatistics - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ItemStatistics(client, missingPercent=None, count=None, median=None, mean=None, p10=None, p90=None, stddev=None, min=None, max=None, lowerBound=None, upperBound=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` ItemStatistics representation. @@ -59,13 +49,11 @@ Module Contents :param upperBound: upper bound threshold of the data :type upperBound: float - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_app/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_app/index.rst.txt index b0de5fe0a..889cdaa46 100644 --- a/docs/_sources/autoapi/abacusai/llm_app/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_app/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.llm_app -================ +:py:mod:`abacusai.llm_app` +========================== .. py:module:: abacusai.llm_app -Classes -------- - -.. autoapisummary:: - - abacusai.llm_app.AbstractApiClass - abacusai.llm_app.LlmApp - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_app.LlmApp - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmApp(client, llmAppId=None, name=None, description=None, projectId=None, deploymentId=None, createdAt=None, updatedAt=None, status=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An LLM App that can be used for generation. LLM Apps are specifically crafted to help with certain tasks like code generation or question answering. @@ -53,13 +43,11 @@ Module Contents :param status: The status of the LLM App's deployment. :type status: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_code_block/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_code_block/index.rst.txt index 7738d396b..179f80bd3 100644 --- a/docs/_sources/autoapi/abacusai/llm_code_block/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_code_block/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.llm_code_block -======================= +:py:mod:`abacusai.llm_code_block` +================================= .. py:module:: abacusai.llm_code_block -Classes -------- - -.. autoapisummary:: - - abacusai.llm_code_block.AbstractApiClass - abacusai.llm_code_block.LlmCodeBlock - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_code_block.LlmCodeBlock - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmCodeBlock(client, language=None, code=None, start=None, end=None, valid=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Parsed code block from an LLM response @@ -47,13 +37,11 @@ Module Contents :param valid: flag denoting whether the soruce code string is syntactically valid :type valid: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_execution_preview/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_execution_preview/index.rst.txt index 080ce6529..412c2a667 100644 --- a/docs/_sources/autoapi/abacusai/llm_execution_preview/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_execution_preview/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.llm_execution_preview -============================== +:py:mod:`abacusai.llm_execution_preview` +======================================== .. py:module:: abacusai.llm_execution_preview -Classes -------- - -.. autoapisummary:: - - abacusai.llm_execution_preview.AbstractApiClass - abacusai.llm_execution_preview.LlmExecutionPreview - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_execution_preview.LlmExecutionPreview - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmExecutionPreview(client, error=None, sql=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Preview of executing queries using LLM. @@ -41,13 +31,11 @@ Module Contents :param sql: Preview of SQL query generated by LLM. :type sql: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_execution_result/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_execution_result/index.rst.txt index 5903cdec0..83599e4b4 100644 --- a/docs/_sources/autoapi/abacusai/llm_execution_result/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_execution_result/index.rst.txt @@ -1,166 +1,26 @@ -abacusai.llm_execution_result -============================= +:py:mod:`abacusai.llm_execution_result` +======================================= .. py:module:: abacusai.llm_execution_result -Classes -------- - -.. autoapisummary:: - - abacusai.llm_execution_result.ExecuteFeatureGroupOperation - abacusai.llm_execution_result.LlmExecutionPreview - abacusai.llm_execution_result.AbstractApiClass - abacusai.llm_execution_result.LlmExecutionResult - - Module Contents --------------- -.. py:class:: ExecuteFeatureGroupOperation(client, featureGroupOperationRunId=None, status=None, error=None, query=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The result of executing a SQL query - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupOperationRunId: The run id of the operation - :type featureGroupOperationRunId: str - :param status: The status of the operation - :type status: str - :param error: The error message if the operation failed - :type error: str - :param query: The SQL query of the operation - :type query: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: wait_for_results(timeout=3600, delay=2) - - A waiting call until query is executed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - :param delay: Polling interval for checking timeout. - :type delay: int - - - - .. py:method:: wait_for_execution(timeout=3600, delay=2) - - A waiting call until query is executed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - :param delay: Polling interval for checking timeout. - :type delay: int - - - - .. py:method:: get_status() - - Gets the status of the query execution - - :returns: A string describing the status of a query execution (pending, complete, etc.). - :rtype: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: DatasetVersion - - - - .. py:method:: describe() - - Gets the description of the query execution - - :returns: A ExecuteFeatureGroupOperation object describing the query execution. - :rtype: ExecuteFeatureGroupOperation - - - - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) - - - .. py:method:: load_as_pandas(max_workers=10) - - Loads the result data into a pandas dataframe - - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe displaying the data from execution. - :rtype: DataFrame - - - -.. py:class:: LlmExecutionPreview(client, error=None, sql=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Preview of executing queries using LLM. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param error: The error message if the preview failed. - :type error: str - :param sql: Preview of SQL query generated by LLM. - :type sql: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_execution_result.LlmExecutionResult - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmExecutionResult(client, status=None, error=None, execution={}, preview={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Results of executing queries using LLM. @@ -175,13 +35,11 @@ Module Contents :param preview: Preview of executing queries using LLM. :type preview: LlmExecutionPreview - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_generated_code/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_generated_code/index.rst.txt index a4cb4b40f..c3081a914 100644 --- a/docs/_sources/autoapi/abacusai/llm_generated_code/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_generated_code/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.llm_generated_code -=========================== +:py:mod:`abacusai.llm_generated_code` +===================================== .. py:module:: abacusai.llm_generated_code -Classes -------- - -.. autoapisummary:: - - abacusai.llm_generated_code.AbstractApiClass - abacusai.llm_generated_code.LlmGeneratedCode - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_generated_code.LlmGeneratedCode - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmGeneratedCode(client, sql=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Code generated by LLM. @@ -39,13 +29,11 @@ Module Contents :param sql: SQL query generated by LLM. :type sql: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_input/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_input/index.rst.txt index e28341fd7..f2471f94c 100644 --- a/docs/_sources/autoapi/abacusai/llm_input/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_input/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.llm_input -================== +:py:mod:`abacusai.llm_input` +============================ .. py:module:: abacusai.llm_input -Classes -------- - -.. autoapisummary:: - - abacusai.llm_input.AbstractApiClass - abacusai.llm_input.LlmInput - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_input.LlmInput - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmInput(client, content=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The result of encoding an object as input for a language model. @@ -39,13 +29,11 @@ Module Contents :param content: Content of the response :type content: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_parameters/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_parameters/index.rst.txt index 0fdafbafc..39ce78206 100644 --- a/docs/_sources/autoapi/abacusai/llm_parameters/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_parameters/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.llm_parameters -======================= +:py:mod:`abacusai.llm_parameters` +================================= .. py:module:: abacusai.llm_parameters -Classes -------- - -.. autoapisummary:: - - abacusai.llm_parameters.AbstractApiClass - abacusai.llm_parameters.LlmParameters - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_parameters.LlmParameters - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmParameters(client, parameters=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The parameters of LLM for given inputs. @@ -39,13 +29,11 @@ Module Contents :param parameters: The parameters of LLM for given inputs. :type parameters: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/llm_response/index.rst.txt b/docs/_sources/autoapi/abacusai/llm_response/index.rst.txt index 2eec702ea..75ca33c2b 100644 --- a/docs/_sources/autoapi/abacusai/llm_response/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/llm_response/index.rst.txt @@ -1,73 +1,26 @@ -abacusai.llm_response -===================== +:py:mod:`abacusai.llm_response` +=============================== .. py:module:: abacusai.llm_response -Classes -------- - -.. autoapisummary:: - - abacusai.llm_response.LlmCodeBlock - abacusai.llm_response.AbstractApiClass - abacusai.llm_response.LlmResponse - - Module Contents --------------- -.. py:class:: LlmCodeBlock(client, language=None, code=None, start=None, end=None, valid=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Parsed code block from an LLM response - - :param client: An authenticated API Client instance - :type client: ApiClient - :param language: The language of the code block. Eg - python/sql/etc. - :type language: str - :param code: source code string - :type code: str - :param start: index of the starting character of the code block in the original response - :type start: int - :param end: index of the last character of the code block in the original response - :type end: int - :param valid: flag denoting whether the soruce code string is syntactically valid - :type valid: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.llm_response.LlmResponse - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: LlmResponse(client, content=None, tokens=None, stopReason=None, llmName=None, codeBlocks={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The response returned by LLM @@ -84,13 +37,11 @@ Module Contents :param codeBlocks: A list of parsed code blocks from raw LLM Response :type codeBlocks: LlmCodeBlock - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/memory_options/index.rst.txt b/docs/_sources/autoapi/abacusai/memory_options/index.rst.txt index 233c5e67f..35e4fb89f 100644 --- a/docs/_sources/autoapi/abacusai/memory_options/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/memory_options/index.rst.txt @@ -1,67 +1,26 @@ -abacusai.memory_options -======================= +:py:mod:`abacusai.memory_options` +================================= .. py:module:: abacusai.memory_options -Classes -------- - -.. autoapisummary:: - - abacusai.memory_options.CpuGpuMemorySpecs - abacusai.memory_options.AbstractApiClass - abacusai.memory_options.MemoryOptions - - Module Contents --------------- -.. py:class:: CpuGpuMemorySpecs(client, default=None, data=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Includes the memory specs of the CPU/GPU - - :param client: An authenticated API Client instance - :type client: ApiClient - :param default: the default memory size for the processing unit - :type default: int - :param data: the list of memory sizes for the processing unit - :type data: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.memory_options.MemoryOptions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: MemoryOptions(client, cpu={}, gpu={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The overall memory options for executing a job @@ -72,13 +31,11 @@ Module Contents :param gpu: Contains information about the default GPU and list of GPU memory & size options :type gpu: CpuGpuMemorySpecs - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/messaging_connector_response/index.rst.txt b/docs/_sources/autoapi/abacusai/messaging_connector_response/index.rst.txt index 895246ebc..44025359e 100644 --- a/docs/_sources/autoapi/abacusai/messaging_connector_response/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/messaging_connector_response/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.messaging_connector_response -===================================== +:py:mod:`abacusai.messaging_connector_response` +=============================================== .. py:module:: abacusai.messaging_connector_response -Classes -------- - -.. autoapisummary:: - - abacusai.messaging_connector_response.AbstractApiClass - abacusai.messaging_connector_response.MessagingConnectorResponse - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.messaging_connector_response.MessagingConnectorResponse - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: MessagingConnectorResponse(client, welcomeMessage=None, defaultMessage=None, disclaimer=None, messagingBotName=None, useDefaultLabel=None, initAckReq=None, defaultLabels=None, enabledExternalLinks=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The response to view label data for Teams @@ -53,13 +43,11 @@ Module Contents :param enabledExternalLinks: list of external application which have external links applicable :type enabledExternalLinks: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model/index.rst.txt b/docs/_sources/autoapi/abacusai/model/index.rst.txt index 23c2d464a..25cf6656d 100644 --- a/docs/_sources/autoapi/abacusai/model/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model/index.rst.txt @@ -1,598 +1,26 @@ -abacusai.model -============== +:py:mod:`abacusai.model` +======================== .. py:module:: abacusai.model -Classes -------- - -.. autoapisummary:: - - abacusai.model.AgentInterface - abacusai.model.TrainingConfig - abacusai.model.WorkflowGraph - abacusai.model.CodeSource - abacusai.model.DatabaseConnector - abacusai.model.ModelLocation - abacusai.model.ModelVersion - abacusai.model.RefreshSchedule - abacusai.model.AbstractApiClass - abacusai.model.Model - - Module Contents --------------- -.. py:class:: AgentInterface - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: DEFAULT - :value: 'DEFAULT' - - - - .. py:attribute:: CHAT - :value: 'CHAT' - - - -.. py:class:: TrainingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the training config options used to train the model. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:attribute:: algorithm - :type: str - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: WorkflowGraph - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. - - :param nodes: A list of nodes in the workflow graph. - :type nodes: List[WorkflowGraphNode] - :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. - :type edges: List[WorkflowGraphEdge] - - - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] - - - .. py:attribute:: edges - :type: List[WorkflowGraphEdge] - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(graph) - :classmethod: - - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: DatabaseConnector(client, databaseConnectorId=None, service=None, name=None, status=None, auth=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A connector to an external service - - :param client: An authenticated API Client instance - :type client: ApiClient - :param databaseConnectorId: A unique string identifier for the connection. - :type databaseConnectorId: str - :param service: An enum string indicating the service this connection connects to. - :type service: str - :param name: A user-friendly name for the service. - :type name: str - :param status: The status of the database connector. - :type status: str - :param auth: Non-secret connection information for this connector. - :type auth: dict - :param createdAt: The ISO-8601 string indicating when the API key was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: list_objects(fetch_raw_data = False) - - Lists querable objects in the database connector. - - :param fetch_raw_data: If true, return unfiltered objects. - :type fetch_raw_data: bool - - - - .. py:method:: get_object_schema(object_name = None, fetch_raw_data = False) - - Get the schema of an object in an database connector. - - :param object_name: Unique identifier for the object in the external system. - :type object_name: str - :param fetch_raw_data: If true, return unfiltered list of columns. - :type fetch_raw_data: bool - - :returns: The schema of the object. - :rtype: DatabaseConnectorSchema - - - - .. py:method:: rename(name) - - Renames a Database Connector - - :param name: The new name for the Database Connector. - :type name: str - - - - .. py:method:: verify() - - Checks if Abacus.AI can access the specified database. - - :param database_connector_id: Unique string identifier for the database connector. - :type database_connector_id: str - - - - .. py:method:: delete() - - Delete a database connector. - - :param database_connector_id: The unique identifier for the database connector. - :type database_connector_id: str - - - - .. py:method:: query(query) - - Runs a query in the specified database connector. - - :param query: The query to be run in the database connector. - :type query: str - - - -.. py:class:: ModelLocation(client, location=None, artifactNames=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Provide location information for the plug-and-play model. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param location: Location of the plug-and-play model. - :type location: str - :param artifactNames: Representations of the names of the artifacts used to create the model. - :type artifactNames: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ModelVersion(client, modelVersion=None, modelConfigType=None, status=None, modelId=None, modelPredictionConfig=None, trainingStartedAt=None, trainingCompletedAt=None, featureGroupVersions=None, error=None, pendingDeploymentIds=None, failedDeploymentIds=None, cpuSize=None, memory=None, automlComplete=None, trainingFeatureGroupIds=None, trainingDocumentRetrieverVersions=None, documentRetrieverMappings=None, bestAlgorithm=None, defaultAlgorithm=None, featureAnalysisStatus=None, dataClusterInfo=None, customAlgorithmConfigs=None, trainedModelTypes=None, useGpu=None, partialComplete=None, modelFeatureGroupSchemaMappings=None, trainingConfigUpdated=None, codeSource={}, modelConfig={}, deployableAlgorithms={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a model - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelVersion: The unique identifier of a model version. - :type modelVersion: str - :param modelConfigType: Name of the TrainingConfig class of the model_config. - :type modelConfigType: str - :param status: The current status of the model. - :type status: str - :param modelId: A reference to the model this version belongs to. - :type modelId: str - :param modelPredictionConfig: The prediction config options for the model. - :type modelPredictionConfig: dict - :param trainingStartedAt: The start time and date of the training process in ISO-8601 format. - :type trainingStartedAt: str - :param trainingCompletedAt: The end time and date of the training process in ISO-8601 format. - :type trainingCompletedAt: str - :param featureGroupVersions: A list of Feature Group version IDs used for model training. - :type featureGroupVersions: list - :param error: Relevant error if the status is FAILED. - :type error: str - :param pendingDeploymentIds: List of deployment IDs where deployment is pending. - :type pendingDeploymentIds: list - :param failedDeploymentIds: List of failed deployment IDs. - :type failedDeploymentIds: list - :param cpuSize: CPU size specified for the python model training. - :type cpuSize: str - :param memory: Memory in GB specified for the python model training. - :type memory: int - :param automlComplete: If true, all algorithms have completed training. - :type automlComplete: bool - :param trainingFeatureGroupIds: The unique identifiers of the feature groups used as inputs during training to create this ModelVersion. - :type trainingFeatureGroupIds: list - :param trainingDocumentRetrieverVersions: The document retriever version IDs used as inputs during training to create this ModelVersion. - :type trainingDocumentRetrieverVersions: list - :param documentRetrieverMappings: mapping of document retriever version to their respective information. - :type documentRetrieverMappings: dict - :param bestAlgorithm: Best performing algorithm. - :type bestAlgorithm: dict - :param defaultAlgorithm: Default algorithm that the user has selected. - :type defaultAlgorithm: dict - :param featureAnalysisStatus: Lifecycle of the feature analysis stage. - :type featureAnalysisStatus: str - :param dataClusterInfo: Information about the models for different data clusters. - :type dataClusterInfo: dict - :param customAlgorithmConfigs: User-defined configs for each of the user-defined custom algorithms. - :type customAlgorithmConfigs: dict - :param trainedModelTypes: List of trained model types. - :type trainedModelTypes: list - :param useGpu: Whether this model version is using gpu - :type useGpu: bool - :param partialComplete: If true, all required algorithms have completed training. - :type partialComplete: bool - :param modelFeatureGroupSchemaMappings: mapping of feature group to schema version - :type modelFeatureGroupSchemaMappings: dict - :param trainingConfigUpdated: If the training config has been updated since the instance was created. - :type trainingConfigUpdated: bool - :param codeSource: If a python model, information on where the source code is located. - :type codeSource: CodeSource - :param modelConfig: The training config options used to train this model. - :type modelConfig: TrainingConfig - :param deployableAlgorithms: List of deployable algorithms. - :type deployableAlgorithms: DeployableAlgorithm - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: describe_train_test_data_split_feature_group_version() - - Get the train and test data split for a trained model by model version. This is only supported for models with custom algorithms. - - :param model_version: The unique version ID of the model version. - :type model_version: str - - :returns: The feature group version containing the training data and folds information. - :rtype: FeatureGroupVersion - - - - .. py:method:: set_model_objective(metric = None) - - Sets the best model for all model instances of the model based on the specified metric, and updates the training configuration to use the specified metric for any future model versions. - - If metric is set to None, then just use the default selection - - - :param metric: The metric to use to determine the best model. - :type metric: str - - - - .. py:method:: get_feature_group_schemas_for() - - Gets the schema (including feature mappings) for all feature groups used in the model version. - - :param model_version: Unique string identifier for the version of the model. - :type model_version: str - - :returns: List of schema for all feature groups used in the model version. - :rtype: list[ModelVersionFeatureGroupSchema] - - - - .. py:method:: delete() - - Deletes the specified model version. Model versions which are currently used in deployments cannot be deleted. - - :param model_version: The unique identifier of the model version to delete. - :type model_version: str - - - - .. py:method:: export_model_artifact_as_feature_group(table_name, artifact_type = None) - - Exports metric artifact data for a model as a feature group. - - :param table_name: Name of the feature group table to create. - :type table_name: str - :param artifact_type: eval artifact type to export. - :type artifact_type: EvalArtifactType - - :returns: The created feature group. - :rtype: FeatureGroup - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ModelVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified model version. - - :param model_version: Unique string identifier of the model version. - :type model_version: str - - :returns: A model version. - :rtype: ModelVersion - - - - .. py:method:: get_feature_importance_by() - - Gets the feature importance calculated by various methods for the model. - - :param model_version: Unique string identifier for the model version. - :type model_version: str - - :returns: Feature importances for the model. - :rtype: FeatureImportance - - - - .. py:method:: get_training_data_logs() - - Retrieves the data preparation logs during model training. - - :param model_version: The unique version ID of the model version. - :type model_version: str - - :returns: A list of logs. - :rtype: list[DataPrepLogs] - - - - .. py:method:: get_training_logs(stdout = False, stderr = False) - - Returns training logs for the model. - - :param stdout: Set True to get info logs. - :type stdout: bool - :param stderr: Set True to get error logs. - :type stderr: bool - - :returns: A function logs object. - :rtype: FunctionLogs - - - - .. py:method:: export_custom(output_location, algorithm = None) - - Bundle custom model artifacts to a zip file, and export to the specified location. - - :param output_location: Location to export the model artifacts results. For example, s3://a-bucket/ - :type output_location: str - :param algorithm: The algorithm to be exported. Optional if there's only one custom algorithm in the model version. - :type algorithm: str - - :returns: Object describing the export and its status. - :rtype: ModelArtifactsExport - - - - .. py:method:: wait_for_training(timeout=None) - - A waiting call until model gets trained. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_full_automl(timeout=None) - - A waiting call until full AutoML cycle is completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model version under training. - - :returns: A string describing the status of a model training (pending, complete, etc.). - :rtype: str - - - - .. py:method:: get_train_test_feature_group_as_pandas() - - Get the model train test data split feature group of the model version as pandas data frame. - - :returns: A pandas dataframe for the training data with fold column. - :rtype: pandas.Dataframe - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model.Model - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Model(client, name=None, modelId=None, modelConfigType=None, modelPredictionConfig=None, createdAt=None, projectId=None, shared=None, sharedAt=None, trainFunctionName=None, predictFunctionName=None, predictManyFunctionName=None, initializeFunctionName=None, trainingInputTables=None, sourceCode=None, cpuSize=None, memory=None, trainingFeatureGroupIds=None, algorithmModelConfigs=None, trainingVectorStoreVersions=None, documentRetrievers=None, documentRetrieverIds=None, isPythonModel=None, defaultAlgorithm=None, customAlgorithmConfigs=None, restrictedAlgorithms=None, useGpu=None, notebookId=None, trainingRequired=None, dataLlmFeatureGroups=None, location={}, refreshSchedules={}, codeSource={}, databaseConnector={}, latestModelVersion={}, modelConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A model @@ -669,13 +97,11 @@ Module Contents :param modelConfig: The training config options used to train this model. :type modelConfig: TrainingConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -684,7 +110,6 @@ Module Contents :rtype: dict - .. py:method:: describe_train_test_data_split_feature_group() Get the train and test data split for a trained model by its unique identifier. This is only supported for models with custom algorithms. @@ -696,7 +121,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -705,7 +129,6 @@ Module Contents :rtype: Model - .. py:method:: describe() Retrieves a full description of the specified model. @@ -717,7 +140,6 @@ Module Contents :rtype: Model - .. py:method:: rename(name) Renames a model @@ -726,7 +148,6 @@ Module Contents :type name: str - .. py:method:: update_python(function_source_code = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None, is_thread_safe = None, training_config = None) Updates an existing Python Model using user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the `train` and `predict` functions with the materialized feature groups for those input feature groups. @@ -763,7 +184,6 @@ Module Contents :rtype: Model - .. py:method:: update_python_zip(train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) Updates an existing Python Model using a provided zip file. If a list of input feature groups are supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -796,7 +216,6 @@ Module Contents :rtype: Upload - .. py:method:: update_python_git(application_connector_id = None, branch_name = None, python_root = None, train_function_name = None, predict_function_name = None, predict_many_function_name = None, train_module_name = None, predict_module_name = None, training_input_tables = None, cpu_size = None, memory = None, use_gpu = None) Updates an existing Python model using an existing Git application connector. If a list of input feature groups are supplied, these will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -833,7 +252,6 @@ Module Contents :rtype: Model - .. py:method:: set_training_config(training_config, feature_group_ids = None) Edits the default model training config @@ -847,7 +265,6 @@ Module Contents :rtype: Model - .. py:method:: set_prediction_params(prediction_config) Sets the model prediction config for the model @@ -859,7 +276,6 @@ Module Contents :rtype: Model - .. py:method:: get_metrics(model_version = None, return_graphs = False, validation = False) Retrieves metrics for all the algorithms trained in this model version. @@ -878,7 +294,6 @@ Module Contents :rtype: ModelMetrics - .. py:method:: list_versions(limit = 100, start_after_version = None) Retrieves a list of versions for a given model. @@ -892,7 +307,6 @@ Module Contents :rtype: list[ModelVersion] - .. py:method:: retrain(deployment_ids = None, feature_group_ids = None, custom_algorithms = None, builtin_algorithms = None, custom_algorithm_configs = None, cpu_size = None, memory = None, training_config = None, algorithm_training_configs = None) Retrains the specified model, with an option to choose the deployments to which the retraining will be deployed. @@ -920,7 +334,6 @@ Module Contents :rtype: Model - .. py:method:: delete() Deletes the specified model and all its versions. Models which are currently used in deployments cannot be deleted. @@ -929,7 +342,6 @@ Module Contents :type model_id: str - .. py:method:: set_default_algorithm(algorithm = None, data_cluster_type = None) Sets the model's algorithm to default for all new deployments @@ -940,7 +352,6 @@ Module Contents :type data_cluster_type: str - .. py:method:: list_artifacts_exports(limit = 25) List all the model artifacts exports. @@ -952,7 +363,6 @@ Module Contents :rtype: list[ModelArtifactsExport] - .. py:method:: get_training_types_for_deployment(model_version = None, algorithm = None) Returns types of models that can be deployed for a given model instance ID. @@ -966,7 +376,6 @@ Module Contents :rtype: ModelTrainingTypeForDeployment - .. py:method:: update_agent(function_source_code = None, agent_function_name = None, memory = None, package_requirements = None, description = None, enable_binary_input = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = None) Updates an existing AI Agent. A new version of the agent will be created and published. @@ -984,7 +393,6 @@ Module Contents :rtype: Agent - .. py:method:: wait_for_training(timeout=None) A waiting call until model is trained. @@ -993,7 +401,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_evaluation(timeout=None) A waiting call until model is evaluated completely. @@ -1002,7 +409,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_publish(timeout=None) A waiting call until agent is published. @@ -1011,7 +417,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_full_automl(timeout=None) A waiting call until full AutoML cycle is completed. @@ -1020,7 +425,6 @@ Module Contents :type timeout: int - .. py:method:: get_status(get_automl_status = False) Gets the status of the model training. @@ -1029,7 +433,6 @@ Module Contents :rtype: str - .. py:method:: create_refresh_policy(cron) To create a refresh policy for a model. @@ -1041,7 +444,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: list_refresh_policies() Gets the refresh policies in a list. @@ -1050,7 +452,6 @@ Module Contents :rtype: List[RefreshPolicy] - .. py:method:: get_train_test_feature_group_as_pandas() Get the model train test data split feature group as pandas. diff --git a/docs/_sources/autoapi/abacusai/model_artifacts_export/index.rst.txt b/docs/_sources/autoapi/abacusai/model_artifacts_export/index.rst.txt index c589dc13a..bde5170e1 100644 --- a/docs/_sources/autoapi/abacusai/model_artifacts_export/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_artifacts_export/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_artifacts_export -=============================== +:py:mod:`abacusai.model_artifacts_export` +========================================= .. py:module:: abacusai.model_artifacts_export -Classes -------- - -.. autoapisummary:: - - abacusai.model_artifacts_export.AbstractApiClass - abacusai.model_artifacts_export.ModelArtifactsExport - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_artifacts_export.ModelArtifactsExport - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelArtifactsExport(client, modelArtifactsExportId=None, modelVersion=None, outputLocation=None, status=None, createdAt=None, exportCompletedAt=None, error=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Model Artifacts Export Job @@ -51,13 +41,11 @@ Module Contents :param error: If `status` is `FAILED`, this field will be populated with an error. :type error: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -66,7 +54,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -75,7 +62,6 @@ Module Contents :rtype: ModelArtifactsExport - .. py:method:: describe() Get the description and status of the model artifacts export. @@ -87,7 +73,6 @@ Module Contents :rtype: ModelArtifactsExport - .. py:method:: wait_for_results(timeout=3600) A waiting call until model artifacts export is created. @@ -96,7 +81,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the model artifacts export. diff --git a/docs/_sources/autoapi/abacusai/model_blueprint_export/index.rst.txt b/docs/_sources/autoapi/abacusai/model_blueprint_export/index.rst.txt index 60441a7b7..5c089790d 100644 --- a/docs/_sources/autoapi/abacusai/model_blueprint_export/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_blueprint_export/index.rst.txt @@ -1,73 +1,26 @@ -abacusai.model_blueprint_export -=============================== +:py:mod:`abacusai.model_blueprint_export` +========================================= .. py:module:: abacusai.model_blueprint_export -Classes -------- - -.. autoapisummary:: - - abacusai.model_blueprint_export.ModelBlueprintStage - abacusai.model_blueprint_export.AbstractApiClass - abacusai.model_blueprint_export.ModelBlueprintExport - - Module Contents --------------- -.. py:class:: ModelBlueprintStage(client, stageName=None, displayName=None, description=None, params=None, predecessors=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A stage in the model blueprint export process. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param stageName: The name of the stage. - :type stageName: str - :param displayName: The display name of the stage. - :type displayName: str - :param description: The description of the stage. - :type description: str - :param params: The parameters for the stage. - :type params: dict - :param predecessors: A list of stages that occur directly before this stage. - :type predecessors: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_blueprint_export.ModelBlueprintExport - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelBlueprintExport(client, modelVersion=None, currentTrainingConfig=None, modelBlueprintStages={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Model Blueprint @@ -80,13 +33,11 @@ Module Contents :param modelBlueprintStages: The stages of the model blueprint. Each one includes the stage name, display name, description, parameters, and predecessors. :type modelBlueprintStages: ModelBlueprintStage - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_blueprint_stage/index.rst.txt b/docs/_sources/autoapi/abacusai/model_blueprint_stage/index.rst.txt index 2612c9674..19ec3f2b4 100644 --- a/docs/_sources/autoapi/abacusai/model_blueprint_stage/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_blueprint_stage/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_blueprint_stage -============================== +:py:mod:`abacusai.model_blueprint_stage` +======================================== .. py:module:: abacusai.model_blueprint_stage -Classes -------- - -.. autoapisummary:: - - abacusai.model_blueprint_stage.AbstractApiClass - abacusai.model_blueprint_stage.ModelBlueprintStage - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_blueprint_stage.ModelBlueprintStage - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelBlueprintStage(client, stageName=None, displayName=None, description=None, params=None, predecessors=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A stage in the model blueprint export process. @@ -47,13 +37,11 @@ Module Contents :param predecessors: A list of stages that occur directly before this stage. :type predecessors: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_location/index.rst.txt b/docs/_sources/autoapi/abacusai/model_location/index.rst.txt index 5333654a6..d96f23532 100644 --- a/docs/_sources/autoapi/abacusai/model_location/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_location/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_location -======================= +:py:mod:`abacusai.model_location` +================================= .. py:module:: abacusai.model_location -Classes -------- - -.. autoapisummary:: - - abacusai.model_location.AbstractApiClass - abacusai.model_location.ModelLocation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_location.ModelLocation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelLocation(client, location=None, artifactNames=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Provide location information for the plug-and-play model. @@ -41,13 +31,11 @@ Module Contents :param artifactNames: Representations of the names of the artifacts used to create the model. :type artifactNames: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_metrics/index.rst.txt b/docs/_sources/autoapi/abacusai/model_metrics/index.rst.txt index 1e85e3106..cd4c846f7 100644 --- a/docs/_sources/autoapi/abacusai/model_metrics/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_metrics/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_metrics -====================== +:py:mod:`abacusai.model_metrics` +================================ .. py:module:: abacusai.model_metrics -Classes -------- - -.. autoapisummary:: - - abacusai.model_metrics.AbstractApiClass - abacusai.model_metrics.ModelMetrics - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_metrics.ModelMetrics - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMetrics(client, algoMetrics=None, selectedAlgorithm=None, selectedAlgorithmName=None, modelId=None, modelVersion=None, metricNames=None, targetColumn=None, trainValTestSplit=None, trainingCompletedAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Metrics of the trained model. @@ -55,13 +45,11 @@ Module Contents :param trainingCompletedAt: Timestamp when training was completed :type trainingCompletedAt: datetime - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_monitor/index.rst.txt b/docs/_sources/autoapi/abacusai/model_monitor/index.rst.txt index 48b17a598..1f3795ae4 100644 --- a/docs/_sources/autoapi/abacusai/model_monitor/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_monitor/index.rst.txt @@ -1,255 +1,26 @@ -abacusai.model_monitor -====================== +:py:mod:`abacusai.model_monitor` +================================ .. py:module:: abacusai.model_monitor -Classes -------- - -.. autoapisummary:: - - abacusai.model_monitor.ModelMonitorVersion - abacusai.model_monitor.RefreshSchedule - abacusai.model_monitor.AbstractApiClass - abacusai.model_monitor.ModelMonitor - - Module Contents --------------- -.. py:class:: ModelMonitorVersion(client, modelMonitorVersion=None, status=None, modelMonitorId=None, monitoringStartedAt=None, monitoringCompletedAt=None, trainingFeatureGroupVersion=None, predictionFeatureGroupVersion=None, error=None, pendingDeploymentIds=None, failedDeploymentIds=None, metricConfigs=None, featureGroupMonitorConfigs=None, metricTypes=None, modelVersion=None, batchPredictionVersion=None, edaConfigs=None, trainingForecastConfig=None, predictionForecastConfig=None, forecastFrequency=None, monitorDriftConfig=None, predictionDataUseMappings=None, trainingDataUseMappings=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a model monitor - - :param client: An authenticated API Client instance - :type client: ApiClient - :param modelMonitorVersion: The unique identifier of a model monitor version. - :type modelMonitorVersion: str - :param status: The current status of the model. - :type status: str - :param modelMonitorId: A reference to the model monitor this version belongs to. - :type modelMonitorId: str - :param monitoringStartedAt: The start time and date of the monitoring process. - :type monitoringStartedAt: str - :param monitoringCompletedAt: The end time and date of the monitoring process. - :type monitoringCompletedAt: str - :param trainingFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is monitoring. - :type trainingFeatureGroupVersion: list[str] - :param predictionFeatureGroupVersion: Feature group version IDs that this refresh pipeline run is monitoring. - :type predictionFeatureGroupVersion: list[str] - :param error: Relevant error if the status is FAILED. - :type error: str - :param pendingDeploymentIds: List of deployment IDs where deployment is pending. - :type pendingDeploymentIds: list - :param failedDeploymentIds: List of failed deployment IDs. - :type failedDeploymentIds: list - :param metricConfigs: List of metric configs for the model monitor instance. - :type metricConfigs: list[dict] - :param featureGroupMonitorConfigs: Configurations for feature group monitor - :type featureGroupMonitorConfigs: dict - :param metricTypes: List of metric types. - :type metricTypes: list - :param modelVersion: Model version IDs that this refresh pipeline run is monitoring. - :type modelVersion: list[str] - :param batchPredictionVersion: The batch prediction version this model monitor is monitoring - :type batchPredictionVersion: str - :param edaConfigs: The list of eda configs for the version - :type edaConfigs: list - :param trainingForecastConfig: The training forecast config for the monitor version - :type trainingForecastConfig: dict - :param predictionForecastConfig: The prediction forecast config for the monitor version - :type predictionForecastConfig: dict - :param forecastFrequency: The forecast frequency for the monitor version - :type forecastFrequency: str - :param monitorDriftConfig: The monitor drift config for the monitor version - :type monitorDriftConfig: dict - :param predictionDataUseMappings: The mapping of prediction data use to feature group version - :type predictionDataUseMappings: dict - :param trainingDataUseMappings: The mapping of training data use to feature group version - :type trainingDataUseMappings: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: get_prediction_drift() - - Gets the label and prediction drifts for a model monitor. - - :param model_monitor_version: Unique string identifier for a model monitor version created under the project. - :type model_monitor_version: str - - :returns: Object describing training and prediction output label and prediction distributions. - :rtype: DriftDistributions - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: ModelMonitorVersion - - - - .. py:method:: describe() - - Retrieves a full description of the specified model monitor version. - - :param model_monitor_version: The unique version ID of the model monitor version. - :type model_monitor_version: str - - :returns: A model monitor version. - :rtype: ModelMonitorVersion - - - - .. py:method:: delete() - - Deletes the specified model monitor version. - - :param model_monitor_version: Unique identifier of the model monitor version to delete. - :type model_monitor_version: str - - - - .. py:method:: metric_data(metric_type, actual_values_to_detail = None) - - Provides the data needed for decile metrics associated with the model monitor. - - :param metric_type: The type of metric to get data for. - :type metric_type: str - :param actual_values_to_detail: The actual values to detail. - :type actual_values_to_detail: list - - :returns: Data associated with the metric. - :rtype: ModelMonitorVersionMetricData - - - - .. py:method:: list_monitor_alert_versions_for_monitor_version() - - Retrieves the list of monitor alert versions for a specified monitor instance. - - :param model_monitor_version: The unique ID associated with the model monitor. - :type model_monitor_version: str - - :returns: A list of monitor alert versions. - :rtype: list[MonitorAlertVersion] - - - - .. py:method:: get_drift_for_feature(feature_name, nested_feature_name = None) - - Gets the feature drift associated with a single feature in an output feature group from a prediction. - - :param feature_name: Name of the feature to view the distribution of. - :type feature_name: str - :param nested_feature_name: Optionally, the name of the nested feature that the feature is in. - :type nested_feature_name: str - - :returns: An object describing the training and prediction output feature distributions. - :rtype: FeatureDistribution - - - - .. py:method:: get_outliers_for_feature(feature_name = None, nested_feature_name = None) - - Gets a list of outliers measured by a single feature (or overall) in an output feature group from a prediction. - - :param feature_name: Name of the feature to view the distribution of. - :type feature_name: str - :param nested_feature_name: Optionally, the name of the nested feature that the feature is in. - :type nested_feature_name: str - - - - .. py:method:: wait_for_monitor(timeout=1200) - - A waiting call until model monitor version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the model monitor version. - - :returns: A string describing the status of the model monitor version, for e.g., pending, complete, etc. - :rtype: str - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_monitor.ModelMonitor - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMonitor(client, modelMonitorId=None, name=None, createdAt=None, projectId=None, trainingFeatureGroupId=None, predictionFeatureGroupId=None, predictionFeatureGroupVersion=None, trainingFeatureGroupVersion=None, alertConfig=None, biasMetricId=None, metricConfigs=None, featureGroupMonitorConfigs=None, metricTypes=None, modelId=None, starred=None, batchPredictionId=None, monitorType=None, edaConfigs=None, trainingForecastConfig=None, predictionForecastConfig=None, forecastFrequency=None, trainingFeatureGroupSampling=None, predictionFeatureGroupSampling=None, monitorDriftConfig=None, predictionDataUseMappings=None, trainingDataUseMappings=None, refreshSchedules={}, latestMonitorModelVersion={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A model monitor @@ -312,13 +83,11 @@ Module Contents :param refreshSchedules: List of refresh schedules that indicate when the next model version will be trained. :type refreshSchedules: RefreshSchedule - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -327,7 +96,6 @@ Module Contents :rtype: dict - .. py:method:: rerun() Re-runs the specified model monitor. @@ -339,7 +107,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -348,7 +115,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: describe() Retrieves a full description of the specified model monitor. @@ -360,7 +126,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: get_summary() Gets the summary of a model monitor across versions. @@ -372,7 +137,6 @@ Module Contents :rtype: ModelMonitorSummary - .. py:method:: list_versions(limit = 100, start_after_version = None) Retrieves a list of versions for a given model monitor. @@ -386,7 +150,6 @@ Module Contents :rtype: list[ModelMonitorVersion] - .. py:method:: rename(name) Renames a model monitor @@ -395,7 +158,6 @@ Module Contents :type name: str - .. py:method:: delete() Deletes the specified Model Monitor and all its versions. @@ -404,7 +166,6 @@ Module Contents :type model_monitor_id: str - .. py:method:: list_monitor_alerts_for_monitor(realtime_monitor_id = None) Retrieves the list of monitor alerts for a specified monitor. One of the model_monitor_id or realtime_monitor_id is required but not both. diff --git a/docs/_sources/autoapi/abacusai/model_monitor_org_summary/index.rst.txt b/docs/_sources/autoapi/abacusai/model_monitor_org_summary/index.rst.txt index 02211770f..1aa478e03 100644 --- a/docs/_sources/autoapi/abacusai/model_monitor_org_summary/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_monitor_org_summary/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_monitor_org_summary -================================== +:py:mod:`abacusai.model_monitor_org_summary` +============================================ .. py:module:: abacusai.model_monitor_org_summary -Classes -------- - -.. autoapisummary:: - - abacusai.model_monitor_org_summary.AbstractApiClass - abacusai.model_monitor_org_summary.ModelMonitorOrgSummary - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_monitor_org_summary.ModelMonitorOrgSummary - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMonitorOrgSummary(client, summary=None, featureDrift=None, labelDrift=None, dataIntegrity=None, performance=None, alerts=None, monitorData=None, totalStarredMonitors=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A summary of an organization's model monitors @@ -53,13 +43,11 @@ Module Contents :param totalStarredMonitors: Total number of starred monitors. :type totalStarredMonitors: int - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_monitor_summary/index.rst.txt b/docs/_sources/autoapi/abacusai/model_monitor_summary/index.rst.txt index 1db974423..32f71acbe 100644 --- a/docs/_sources/autoapi/abacusai/model_monitor_summary/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_monitor_summary/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_monitor_summary -============================== +:py:mod:`abacusai.model_monitor_summary` +======================================== .. py:module:: abacusai.model_monitor_summary -Classes -------- - -.. autoapisummary:: - - abacusai.model_monitor_summary.AbstractApiClass - abacusai.model_monitor_summary.ModelMonitorSummary - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_monitor_summary.ModelMonitorSummary - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMonitorSummary(client, modelAccuracy=None, modelDrift=None, dataIntegrity=None, biasViolations=None, alerts=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A summary of model monitor @@ -47,13 +37,11 @@ Module Contents :param alerts: A list of alerts by type for each model monitor instance :type alerts: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_monitor_summary_from_org/index.rst.txt b/docs/_sources/autoapi/abacusai/model_monitor_summary_from_org/index.rst.txt index 7b609256f..9ba78995e 100644 --- a/docs/_sources/autoapi/abacusai/model_monitor_summary_from_org/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_monitor_summary_from_org/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_monitor_summary_from_org -======================================= +:py:mod:`abacusai.model_monitor_summary_from_org` +================================================= .. py:module:: abacusai.model_monitor_summary_from_org -Classes -------- - -.. autoapisummary:: - - abacusai.model_monitor_summary_from_org.AbstractApiClass - abacusai.model_monitor_summary_from_org.ModelMonitorSummaryFromOrg - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_monitor_summary_from_org.ModelMonitorSummaryFromOrg - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMonitorSummaryFromOrg(client, data=None, infos=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A summary of model monitor given an organization @@ -41,13 +31,11 @@ Module Contents :param infos: A dictionary of model monitor information. :type infos: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_monitor_version/index.rst.txt b/docs/_sources/autoapi/abacusai/model_monitor_version/index.rst.txt index 534d6e4c4..80684a96b 100644 --- a/docs/_sources/autoapi/abacusai/model_monitor_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_monitor_version/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_monitor_version -============================== +:py:mod:`abacusai.model_monitor_version` +======================================== .. py:module:: abacusai.model_monitor_version -Classes -------- - -.. autoapisummary:: - - abacusai.model_monitor_version.AbstractApiClass - abacusai.model_monitor_version.ModelMonitorVersion - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_monitor_version.ModelMonitorVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMonitorVersion(client, modelMonitorVersion=None, status=None, modelMonitorId=None, monitoringStartedAt=None, monitoringCompletedAt=None, trainingFeatureGroupVersion=None, predictionFeatureGroupVersion=None, error=None, pendingDeploymentIds=None, failedDeploymentIds=None, metricConfigs=None, featureGroupMonitorConfigs=None, metricTypes=None, modelVersion=None, batchPredictionVersion=None, edaConfigs=None, trainingForecastConfig=None, predictionForecastConfig=None, forecastFrequency=None, monitorDriftConfig=None, predictionDataUseMappings=None, trainingDataUseMappings=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of a model monitor @@ -81,13 +71,11 @@ Module Contents :param trainingDataUseMappings: The mapping of training data use to feature group version :type trainingDataUseMappings: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -96,7 +84,6 @@ Module Contents :rtype: dict - .. py:method:: get_prediction_drift() Gets the label and prediction drifts for a model monitor. @@ -108,7 +95,6 @@ Module Contents :rtype: DriftDistributions - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -117,7 +103,6 @@ Module Contents :rtype: ModelMonitorVersion - .. py:method:: describe() Retrieves a full description of the specified model monitor version. @@ -129,7 +114,6 @@ Module Contents :rtype: ModelMonitorVersion - .. py:method:: delete() Deletes the specified model monitor version. @@ -138,7 +122,6 @@ Module Contents :type model_monitor_version: str - .. py:method:: metric_data(metric_type, actual_values_to_detail = None) Provides the data needed for decile metrics associated with the model monitor. @@ -152,7 +135,6 @@ Module Contents :rtype: ModelMonitorVersionMetricData - .. py:method:: list_monitor_alert_versions_for_monitor_version() Retrieves the list of monitor alert versions for a specified monitor instance. @@ -164,7 +146,6 @@ Module Contents :rtype: list[MonitorAlertVersion] - .. py:method:: get_drift_for_feature(feature_name, nested_feature_name = None) Gets the feature drift associated with a single feature in an output feature group from a prediction. @@ -178,7 +159,6 @@ Module Contents :rtype: FeatureDistribution - .. py:method:: get_outliers_for_feature(feature_name = None, nested_feature_name = None) Gets a list of outliers measured by a single feature (or overall) in an output feature group from a prediction. @@ -189,7 +169,6 @@ Module Contents :type nested_feature_name: str - .. py:method:: wait_for_monitor(timeout=1200) A waiting call until model monitor version is ready. @@ -198,7 +177,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the model monitor version. diff --git a/docs/_sources/autoapi/abacusai/model_monitor_version_metric_data/index.rst.txt b/docs/_sources/autoapi/abacusai/model_monitor_version_metric_data/index.rst.txt index e6086ebd6..6e0b902c7 100644 --- a/docs/_sources/autoapi/abacusai/model_monitor_version_metric_data/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_monitor_version_metric_data/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_monitor_version_metric_data -========================================== +:py:mod:`abacusai.model_monitor_version_metric_data` +==================================================== .. py:module:: abacusai.model_monitor_version_metric_data -Classes -------- - -.. autoapisummary:: - - abacusai.model_monitor_version_metric_data.AbstractApiClass - abacusai.model_monitor_version_metric_data.ModelMonitorVersionMetricData - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_monitor_version_metric_data.ModelMonitorVersionMetricData - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelMonitorVersionMetricData(client, name=None, algoName=None, featureGroupVersion=None, modelMonitor=None, modelMonitorVersion=None, metricInfos=None, metricNames=None, metrics=None, metricCharts=None, otherMetrics=None, actualValuesSupportedForDrilldown=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Data for displaying model monitor version metric data @@ -59,13 +49,11 @@ Module Contents :param actualValuesSupportedForDrilldown: List of values support for drilldown :type actualValuesSupportedForDrilldown: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_training_type_for_deployment/index.rst.txt b/docs/_sources/autoapi/abacusai/model_training_type_for_deployment/index.rst.txt index c9288322c..d910e5c20 100644 --- a/docs/_sources/autoapi/abacusai/model_training_type_for_deployment/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_training_type_for_deployment/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_training_type_for_deployment -=========================================== +:py:mod:`abacusai.model_training_type_for_deployment` +===================================================== .. py:module:: abacusai.model_training_type_for_deployment -Classes -------- - -.. autoapisummary:: - - abacusai.model_training_type_for_deployment.AbstractApiClass - abacusai.model_training_type_for_deployment.ModelTrainingTypeForDeployment - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_training_type_for_deployment.ModelTrainingTypeForDeployment - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelTrainingTypeForDeployment(client, label=None, value=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Model training types for deployment. @@ -41,13 +31,11 @@ Module Contents :param value: Value to use on backend for deployment API call :type value: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_upload/index.rst.txt b/docs/_sources/autoapi/abacusai/model_upload/index.rst.txt index a37c7a5c1..8c19500d9 100644 --- a/docs/_sources/autoapi/abacusai/model_upload/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_upload/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.model_upload -===================== +:py:mod:`abacusai.model_upload` +=============================== .. py:module:: abacusai.model_upload -Classes -------- - -.. autoapisummary:: - - abacusai.model_upload.AbstractApiClass - abacusai.model_upload.ModelUpload - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_upload.ModelUpload - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelUpload(client, modelId=None, modelVersion=None, status=None, createdAt=None, modelUploadId=None, embeddingsUploadId=None, artifactsUploadId=None, verificationsUploadId=None, defaultItemsUploadId=None, modelFileUploadId=None, modelStateUploadId=None, inputPreprocessorUploadId=None, requirementsUploadId=None, resourcesUploadId=None, multiCatalogEmbeddingsUploadId=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A model version that includes the upload identifiers for the various required files. @@ -67,13 +57,11 @@ Module Contents :param multiCatalogEmbeddingsUploadId: An upload identifier to be used when upload the multi-catalog embeddings CSV file. :type multiCatalogEmbeddingsUploadId: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/model_version/index.rst.txt b/docs/_sources/autoapi/abacusai/model_version/index.rst.txt index 9a22da74a..9f62ebe70 100644 --- a/docs/_sources/autoapi/abacusai/model_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_version/index.rst.txt @@ -1,181 +1,26 @@ -abacusai.model_version -====================== +:py:mod:`abacusai.model_version` +================================ .. py:module:: abacusai.model_version -Classes -------- - -.. autoapisummary:: - - abacusai.model_version.DeployableAlgorithm - abacusai.model_version.EvalArtifactType - abacusai.model_version.TrainingConfig - abacusai.model_version.CodeSource - abacusai.model_version.AbstractApiClass - abacusai.model_version.ModelVersion - - Module Contents --------------- -.. py:class:: DeployableAlgorithm - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Algorithm that can be deployed to a model. - - :param algorithm: ID of the algorithm. - :type algorithm: str - :param name: Name of the algorithm. - :type name: str - :param only_offline_deployable: Whether the algorithm can only be deployed offline. - :type only_offline_deployable: bool - :param trained_model_types: List of trained model types. - :type trained_model_types: List[dict] - - - .. py:attribute:: algorithm - :type: str - - - .. py:attribute:: name - :type: str - - - .. py:attribute:: only_offline_deployable - :type: bool - - - .. py:attribute:: trained_model_types - :type: List[dict] - - -.. py:class:: EvalArtifactType - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: FORECASTING_ACCURACY - :value: 'bar_chart' - - - - .. py:attribute:: FORECASTING_VOLUME - :value: 'bar_chart_volume' - - - - .. py:attribute:: FORECASTING_HISTORY_LENGTH_ACCURACY - :value: 'bar_chart_accuracy_by_history' - - - -.. py:class:: TrainingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the training config options used to train the model. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:attribute:: algorithm - :type: str - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.model_version.ModelVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModelVersion(client, modelVersion=None, modelConfigType=None, status=None, modelId=None, modelPredictionConfig=None, trainingStartedAt=None, trainingCompletedAt=None, featureGroupVersions=None, error=None, pendingDeploymentIds=None, failedDeploymentIds=None, cpuSize=None, memory=None, automlComplete=None, trainingFeatureGroupIds=None, trainingDocumentRetrieverVersions=None, documentRetrieverMappings=None, bestAlgorithm=None, defaultAlgorithm=None, featureAnalysisStatus=None, dataClusterInfo=None, customAlgorithmConfigs=None, trainedModelTypes=None, useGpu=None, partialComplete=None, modelFeatureGroupSchemaMappings=None, trainingConfigUpdated=None, codeSource={}, modelConfig={}, deployableAlgorithms={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of a model @@ -242,13 +87,11 @@ Module Contents :param deployableAlgorithms: List of deployable algorithms. :type deployableAlgorithms: DeployableAlgorithm - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -257,7 +100,6 @@ Module Contents :rtype: dict - .. py:method:: describe_train_test_data_split_feature_group_version() Get the train and test data split for a trained model by model version. This is only supported for models with custom algorithms. @@ -269,7 +111,6 @@ Module Contents :rtype: FeatureGroupVersion - .. py:method:: set_model_objective(metric = None) Sets the best model for all model instances of the model based on the specified metric, and updates the training configuration to use the specified metric for any future model versions. @@ -281,7 +122,6 @@ Module Contents :type metric: str - .. py:method:: get_feature_group_schemas_for() Gets the schema (including feature mappings) for all feature groups used in the model version. @@ -293,7 +133,6 @@ Module Contents :rtype: list[ModelVersionFeatureGroupSchema] - .. py:method:: delete() Deletes the specified model version. Model versions which are currently used in deployments cannot be deleted. @@ -302,7 +141,6 @@ Module Contents :type model_version: str - .. py:method:: export_model_artifact_as_feature_group(table_name, artifact_type = None) Exports metric artifact data for a model as a feature group. @@ -316,7 +154,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -325,7 +162,6 @@ Module Contents :rtype: ModelVersion - .. py:method:: describe() Retrieves a full description of the specified model version. @@ -337,7 +173,6 @@ Module Contents :rtype: ModelVersion - .. py:method:: get_feature_importance_by() Gets the feature importance calculated by various methods for the model. @@ -349,7 +184,6 @@ Module Contents :rtype: FeatureImportance - .. py:method:: get_training_data_logs() Retrieves the data preparation logs during model training. @@ -361,7 +195,6 @@ Module Contents :rtype: list[DataPrepLogs] - .. py:method:: get_training_logs(stdout = False, stderr = False) Returns training logs for the model. @@ -375,7 +208,6 @@ Module Contents :rtype: FunctionLogs - .. py:method:: export_custom(output_location, algorithm = None) Bundle custom model artifacts to a zip file, and export to the specified location. @@ -389,7 +221,6 @@ Module Contents :rtype: ModelArtifactsExport - .. py:method:: wait_for_training(timeout=None) A waiting call until model gets trained. @@ -398,7 +229,6 @@ Module Contents :type timeout: int - .. py:method:: wait_for_full_automl(timeout=None) A waiting call until full AutoML cycle is completed. @@ -407,7 +237,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the model version under training. @@ -416,7 +245,6 @@ Module Contents :rtype: str - .. py:method:: get_train_test_feature_group_as_pandas() Get the model train test data split feature group of the model version as pandas data frame. diff --git a/docs/_sources/autoapi/abacusai/model_version_feature_group_schema/index.rst.txt b/docs/_sources/autoapi/abacusai/model_version_feature_group_schema/index.rst.txt index 802eebcd5..210f10e8b 100644 --- a/docs/_sources/autoapi/abacusai/model_version_feature_group_schema/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/model_version_feature_group_schema/index.rst.txt @@ -1,81 +1,26 @@ -abacusai.model_version_feature_group_schema -=========================================== +:py:mod:`abacusai.model_version_feature_group_schema` +===================================================== .. py:module:: abacusai.model_version_feature_group_schema -Classes -------- - -.. autoapisummary:: - - abacusai.model_version_feature_group_schema.AbstractApiClass - abacusai.model_version_feature_group_schema.Schema - abacusai.model_version_feature_group_schema.ModelVersionFeatureGroupSchema - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: _get_attribute_as_dict(attribute) - - -.. py:class:: Schema(client, name=None, featureMapping=None, detectedFeatureMapping=None, featureType=None, detectedFeatureType=None, dataType=None, detectedDataType=None, nestedFeatures={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the feature. - :type name: str - :param featureMapping: The mapping of the feature. The possible values will be based on the project's use-case. See the (Use Case Documentation)[https://api.abacus.ai/app/help/useCases] for more details. - :type featureMapping: str - :param detectedFeatureMapping: Detected feature mapping for this feature - :type detectedFeatureMapping: str - :param featureType: The underlying data type of each feature: CATEGORICAL, CATEGORICAL_LIST, NUMERICAL, TIMESTAMP, TEXT, EMAIL, LABEL_LIST, ENTITY_LABEL_LIST, PAGE_LABEL_LIST, JSON, OBJECT_REFERENCE, MULTICATEGORICAL_LIST, COORDINATE_LIST, NUMERICAL_LIST, TIMESTAMP_LIST, ZIPCODE, URL, PAGE_INFOS, PAGES_DOCUMENT, TOKENS_DOCUMENT. - :type featureType: str - :param detectedFeatureType: The detected feature type for this feature - :type detectedFeatureType: str - :param dataType: The underlying data type of each feature: INTEGER, FLOAT, STRING, DATE, DATETIME, BOOLEAN, LIST, STRUCT, NULL, BINARY. - :type dataType: str - :param detectedDataType: The detected data type for this feature - :type detectedDataType: str - :param nestedFeatures: List of features of nested feature - :type nestedFeatures: NestedFeatureSchema - :param pointInTimeInfo: Point in time information for this feature - :type pointInTimeInfo: PointInTimeFeatureInfo - - - .. py:method:: __repr__() - - Return repr(self). - - +Classes +~~~~~~~ - .. py:method:: to_dict() +.. autoapisummary:: - Get a dict representation of the parameters in this class + abacusai.model_version_feature_group_schema.ModelVersionFeatureGroupSchema - :returns: The dict value representation of the class parameters - :rtype: dict .. py:class:: ModelVersionFeatureGroupSchema(client, featureGroupId=None, featureGroupName=None, schema={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Schema for a feature group used in model version @@ -88,13 +33,11 @@ Module Contents :param schema: List of feature schemas of a feature group. :type schema: Schema - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/modification_lock_info/index.rst.txt b/docs/_sources/autoapi/abacusai/modification_lock_info/index.rst.txt index f948cc77e..a3c632bf6 100644 --- a/docs/_sources/autoapi/abacusai/modification_lock_info/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/modification_lock_info/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.modification_lock_info -=============================== +:py:mod:`abacusai.modification_lock_info` +========================================= .. py:module:: abacusai.modification_lock_info -Classes -------- - -.. autoapisummary:: - - abacusai.modification_lock_info.AbstractApiClass - abacusai.modification_lock_info.ModificationLockInfo - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.modification_lock_info.ModificationLockInfo - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ModificationLockInfo(client, modificationLock=None, userEmails=None, organizationGroups=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Information about a modification lock for a certain object @@ -43,13 +33,11 @@ Module Contents :param organizationGroups: The list organization groups allowed to modify the object if the object's modification lock is activated. :type organizationGroups: list of unique string identifiers - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/module/index.rst.txt b/docs/_sources/autoapi/abacusai/module/index.rst.txt index cfd912f7b..a23f0b406 100644 --- a/docs/_sources/autoapi/abacusai/module/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/module/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.module -=============== +:py:mod:`abacusai.module` +========================= .. py:module:: abacusai.module -Classes -------- - -.. autoapisummary:: - - abacusai.module.CodeSource - abacusai.module.AbstractApiClass - abacusai.module.Module - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.module.Module - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Module(client, name=None, createdAt=None, notebookId=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Customer created python module @@ -96,13 +35,11 @@ Module Contents :param codeSource: Information about the source code of the Python function. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/monitor_alert/index.rst.txt b/docs/_sources/autoapi/abacusai/monitor_alert/index.rst.txt index c1c520044..a2dc549bd 100644 --- a/docs/_sources/autoapi/abacusai/monitor_alert/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/monitor_alert/index.rst.txt @@ -1,176 +1,26 @@ -abacusai.monitor_alert -====================== +:py:mod:`abacusai.monitor_alert` +================================ .. py:module:: abacusai.monitor_alert -Classes -------- - -.. autoapisummary:: - - abacusai.monitor_alert.AlertActionConfig - abacusai.monitor_alert.AlertConditionConfig - abacusai.monitor_alert.MonitorAlertVersion - abacusai.monitor_alert.AbstractApiClass - abacusai.monitor_alert.MonitorAlert - - Module Contents --------------- -.. py:class:: AlertActionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert action configs - - - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: AlertConditionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert condition configs - - - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: MonitorAlertVersion(client, name=None, monitorAlertVersion=None, monitorAlertId=None, status=None, createdAt=None, alertingStartedAt=None, alertingCompletedAt=None, error=None, modelMonitorVersion=None, conditionConfig=None, actionConfig=None, alertResult=None, actionStatus=None, actionError=None, actionStartedAt=None, actionCompletedAt=None, conditionDescription=None, actionDescription=None, alertType=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A monitor alert version - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The user-friendly name for the monitor alert. - :type name: str - :param monitorAlertVersion: The identifier for the alert version. - :type monitorAlertVersion: str - :param monitorAlertId: The identifier for the alert. - :type monitorAlertId: str - :param status: The current status of the monitor alert. - :type status: str - :param createdAt: Date and time at which the monitor alert was created. - :type createdAt: str - :param alertingStartedAt: The start time and date of the monitor alerting process. - :type alertingStartedAt: str - :param alertingCompletedAt: The end time and date of the monitor alerting process. - :type alertingCompletedAt: str - :param error: Relevant error if the status is FAILED. - :type error: str - :param modelMonitorVersion: The model monitor version associated with the monitor alert version. - :type modelMonitorVersion: str - :param conditionConfig: The condition configuration for this alert. - :type conditionConfig: dict - :param actionConfig: The action configuration for this alert. - :type actionConfig: dict - :param alertResult: The current result of the alert - :type alertResult: str - :param actionStatus: The current status of the action as a result of the monitor alert. - :type actionStatus: str - :param actionError: Relevant error if the action status is FAILED. - :type actionError: str - :param actionStartedAt: The start time and date of the actionfor the alerting process. - :type actionStartedAt: str - :param actionCompletedAt: The end time and date of the actionfor the alerting process. - :type actionCompletedAt: str - :param conditionDescription: User friendly description of the condition - :type conditionDescription: str - :param actionDescription: User friendly description of the action - :type actionDescription: str - :param alertType: The type of the alert - :type alertType: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: MonitorAlertVersion - - - - .. py:method:: describe() - - Describes a given monitor alert version id - - :param monitor_alert_version: Unique string identifier for the monitor alert. - :type monitor_alert_version: str - - :returns: An object describing the monitor alert version. - :rtype: MonitorAlertVersion - - - - .. py:method:: wait_for_monitor_alert(timeout=1200) - - A waiting call until model monitor version is ready. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the monitor alert version. - - :returns: A string describing the status of a monitor alert version (pending, running, complete, etc.). - :rtype: str - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.monitor_alert.MonitorAlert - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: MonitorAlert(client, name=None, monitorAlertId=None, createdAt=None, projectId=None, modelMonitorId=None, realtimeMonitorId=None, conditionConfig=None, actionConfig=None, conditionDescription=None, actionDescription=None, alertType=None, deploymentId=None, latestMonitorAlertVersion={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Monitor Alert @@ -203,13 +53,11 @@ Module Contents :param latestMonitorAlertVersion: The latest monitor alert version. :type latestMonitorAlertVersion: MonitorAlertVersion - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -218,7 +66,6 @@ Module Contents :rtype: dict - .. py:method:: update(alert_name = None, condition_config = None, action_config = None) Update monitor alert @@ -234,7 +81,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -243,7 +89,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: describe() Describes a given monitor alert id @@ -255,7 +100,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: run() Reruns a given monitor alert from latest monitor instance @@ -267,7 +111,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: delete() Delets a monitor alert diff --git a/docs/_sources/autoapi/abacusai/monitor_alert_version/index.rst.txt b/docs/_sources/autoapi/abacusai/monitor_alert_version/index.rst.txt index 61a9b2440..4b6684820 100644 --- a/docs/_sources/autoapi/abacusai/monitor_alert_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/monitor_alert_version/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.monitor_alert_version -============================== +:py:mod:`abacusai.monitor_alert_version` +======================================== .. py:module:: abacusai.monitor_alert_version -Classes -------- - -.. autoapisummary:: - - abacusai.monitor_alert_version.AbstractApiClass - abacusai.monitor_alert_version.MonitorAlertVersion - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.monitor_alert_version.MonitorAlertVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: MonitorAlertVersion(client, name=None, monitorAlertVersion=None, monitorAlertId=None, status=None, createdAt=None, alertingStartedAt=None, alertingCompletedAt=None, error=None, modelMonitorVersion=None, conditionConfig=None, actionConfig=None, alertResult=None, actionStatus=None, actionError=None, actionStartedAt=None, actionCompletedAt=None, conditionDescription=None, actionDescription=None, alertType=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A monitor alert version @@ -75,13 +65,11 @@ Module Contents :param alertType: The type of the alert :type alertType: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -90,7 +78,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -99,7 +86,6 @@ Module Contents :rtype: MonitorAlertVersion - .. py:method:: describe() Describes a given monitor alert version id @@ -111,7 +97,6 @@ Module Contents :rtype: MonitorAlertVersion - .. py:method:: wait_for_monitor_alert(timeout=1200) A waiting call until model monitor version is ready. @@ -120,7 +105,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the monitor alert version. diff --git a/docs/_sources/autoapi/abacusai/monitor_drift_and_distributions/index.rst.txt b/docs/_sources/autoapi/abacusai/monitor_drift_and_distributions/index.rst.txt index d536bc138..05bbae1ed 100644 --- a/docs/_sources/autoapi/abacusai/monitor_drift_and_distributions/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/monitor_drift_and_distributions/index.rst.txt @@ -1,136 +1,26 @@ -abacusai.monitor_drift_and_distributions -======================================== +:py:mod:`abacusai.monitor_drift_and_distributions` +================================================== .. py:module:: abacusai.monitor_drift_and_distributions -Classes -------- - -.. autoapisummary:: - - abacusai.monitor_drift_and_distributions.EmbeddingFeatureDriftDistribution - abacusai.monitor_drift_and_distributions.ForecastingMonitorSummary - abacusai.monitor_drift_and_distributions.AbstractApiClass - abacusai.monitor_drift_and_distributions.MonitorDriftAndDistributions - - Module Contents --------------- -.. py:class:: EmbeddingFeatureDriftDistribution(client, distance=None, jsDistance=None, wsDistance=None, ksStatistic=None, psi=None, csi=None, chiSquare=None, averageDrift={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Feature distribution for embeddings - - :param client: An authenticated API Client instance - :type client: ApiClient - :param distance: Histogram data of KL divergences between the training distribution and the range of values in the specified window. - :type distance: list - :param jsDistance: Histogram data of JS divergence between the training distribution and the range of values in the specified window. - :type jsDistance: list - :param wsDistance: Histogram data of Wasserstein distance between the training distribution and the range of values in the specified window. - :type wsDistance: list - :param ksStatistic: Histogram data of Kolmogorov-Smirnov statistic computed between the training distribution and the range of values in the specified window. - :type ksStatistic: list - :param psi: Histogram data of Population stability index computed between the training distribution and the range of values in the specified window. - :type psi: list - :param csi: Histogram data of Characteristic Stability Index computed between the training distribution and the range of values in the specified window. - :type csi: list - :param chiSquare: Histogram data of Chi-square statistic computed between the training distribution and the range of values in the specified window. - :type chiSquare: list - :param averageDrift: Average drift embedding for each type of drift - :type averageDrift: DriftTypesValue - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ForecastingMonitorSummary(client, predictionTimestampCol=None, predictionTargetCol=None, trainingTimestampCol=None, trainingTargetCol=None, predictionItemId=None, trainingItemId=None, forecastFrequency=None, trainingTargetAcrossTime={}, predictionTargetAcrossTime={}, actualsHistogram={}, predictionsHistogram={}, trainHistoryData={}, predictHistoryData={}, targetDrift={}, historyDrift={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Forecasting Monitor Summary of the latest version of the data. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param predictionTimestampCol: Feature in the data that represents the timestamp column. - :type predictionTimestampCol: str - :param predictionTargetCol: Feature in the data that represents the target. - :type predictionTargetCol: str - :param trainingTimestampCol: Feature in the data that represents the timestamp column. - :type trainingTimestampCol: str - :param trainingTargetCol: Feature in the data that represents the target. - :type trainingTargetCol: str - :param predictionItemId: Feature in the data that represents the item id. - :type predictionItemId: str - :param trainingItemId: Feature in the data that represents the item id. - :type trainingItemId: str - :param forecastFrequency: Frequency of data, could be hourly, daily, weekly, monthly, quarterly or yearly. - :type forecastFrequency: str - :param trainingTargetAcrossTime: Data showing average, p10, p90, median sales across time - :type trainingTargetAcrossTime: ForecastingAnalysisGraphData - :param predictionTargetAcrossTime: Data showing average, p10, p90, median sales across time - :type predictionTargetAcrossTime: ForecastingAnalysisGraphData - :param actualsHistogram: Data showing actuals histogram - :type actualsHistogram: ForecastingAnalysisGraphData - :param predictionsHistogram: Data showing predictions histogram - :type predictionsHistogram: ForecastingAnalysisGraphData - :param trainHistoryData: Data showing length of history distribution - :type trainHistoryData: ForecastingAnalysisGraphData - :param predictHistoryData: Data showing length of history distribution - :type predictHistoryData: ForecastingAnalysisGraphData - :param targetDrift: Data showing drift of the target for all drift types: distance (KL divergence), js_distance, ws_distance, ks_statistic, psi, csi, chi_square - :type targetDrift: FeatureDriftRecord - :param historyDrift: Data showing drift of the history for all drift types: distance (KL divergence), js_distance, ws_distance, ks_statistic, psi, csi, chi_square - :type historyDrift: FeatureDriftRecord - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.monitor_drift_and_distributions.MonitorDriftAndDistributions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: MonitorDriftAndDistributions(client, featureDrifts=None, featureDistributions=None, nestedDrifts=None, forecastingMonitorSummary={}, embeddingsDistribution={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Summary of important model monitoring statistics for features available in a model monitoring instance @@ -147,13 +37,11 @@ Module Contents :param embeddingsDistribution: Summary of important model monitoring statistics for features available in a model monitoring instance :type embeddingsDistribution: EmbeddingFeatureDriftDistribution - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/natural_language_explanation/index.rst.txt b/docs/_sources/autoapi/abacusai/natural_language_explanation/index.rst.txt index 6265bcc23..02d3be544 100644 --- a/docs/_sources/autoapi/abacusai/natural_language_explanation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/natural_language_explanation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.natural_language_explanation -===================================== +:py:mod:`abacusai.natural_language_explanation` +=============================================== .. py:module:: abacusai.natural_language_explanation -Classes -------- - -.. autoapisummary:: - - abacusai.natural_language_explanation.AbstractApiClass - abacusai.natural_language_explanation.NaturalLanguageExplanation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.natural_language_explanation.NaturalLanguageExplanation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: NaturalLanguageExplanation(client, shortExplanation=None, longExplanation=None, isOutdated=None, htmlExplanation=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Natural language explanation of an artifact/object @@ -45,13 +35,11 @@ Module Contents :param htmlExplanation: HTML formatted explanation of the artifact :type htmlExplanation: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/nested_feature/index.rst.txt b/docs/_sources/autoapi/abacusai/nested_feature/index.rst.txt index 57023f35b..16295b94a 100644 --- a/docs/_sources/autoapi/abacusai/nested_feature/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/nested_feature/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.nested_feature -======================= +:py:mod:`abacusai.nested_feature` +================================= .. py:module:: abacusai.nested_feature -Classes -------- - -.. autoapisummary:: - - abacusai.nested_feature.AbstractApiClass - abacusai.nested_feature.NestedFeature - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.nested_feature.NestedFeature - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: NestedFeature(client, name=None, selectClause=None, featureType=None, featureMapping=None, dataType=None, sourceTable=None, originalName=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A nested feature in a feature group @@ -51,13 +41,11 @@ Module Contents :param originalName: The original name of the column :type originalName: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/nested_feature_schema/index.rst.txt b/docs/_sources/autoapi/abacusai/nested_feature_schema/index.rst.txt index 991487611..59ad16d08 100644 --- a/docs/_sources/autoapi/abacusai/nested_feature_schema/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/nested_feature_schema/index.rst.txt @@ -1,67 +1,26 @@ -abacusai.nested_feature_schema -============================== +:py:mod:`abacusai.nested_feature_schema` +======================================== .. py:module:: abacusai.nested_feature_schema -Classes -------- - -.. autoapisummary:: - - abacusai.nested_feature_schema.PointInTimeFeatureInfo - abacusai.nested_feature_schema.AbstractApiClass - abacusai.nested_feature_schema.NestedFeatureSchema - - Module Contents --------------- -.. py:class:: PointInTimeFeatureInfo(client, expression=None, groupName=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point-in-time infos for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param groupName: The group name this point-in-time feature belongs to. - :type groupName: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.nested_feature_schema.NestedFeatureSchema - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: NestedFeatureSchema(client, name=None, featureType=None, featureMapping=None, dataType=None, detectedFeatureType=None, sourceTable=None, pointInTimeInfo={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A schema description for a nested feature @@ -82,13 +41,11 @@ Module Contents :param pointInTimeInfo: Point in time information for this feature :type pointInTimeInfo: PointInTimeFeatureInfo - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/null_violation/index.rst.txt b/docs/_sources/autoapi/abacusai/null_violation/index.rst.txt index 6c3e74b94..e73a38e6e 100644 --- a/docs/_sources/autoapi/abacusai/null_violation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/null_violation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.null_violation -======================= +:py:mod:`abacusai.null_violation` +================================= .. py:module:: abacusai.null_violation -Classes -------- - -.. autoapisummary:: - - abacusai.null_violation.AbstractApiClass - abacusai.null_violation.NullViolation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.null_violation.NullViolation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: NullViolation(client, name=None, violation=None, trainingNullFreq=None, predictionNullFreq=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Summary of anomalous null frequencies for a feature discovered by a model monitoring instance @@ -45,13 +35,11 @@ Module Contents :param predictionNullFreq: Proportion of null entries in prediction feature. :type predictionNullFreq: float - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/organization_external_application_settings/index.rst.txt b/docs/_sources/autoapi/abacusai/organization_external_application_settings/index.rst.txt index e61d28105..ca42f8df1 100644 --- a/docs/_sources/autoapi/abacusai/organization_external_application_settings/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/organization_external_application_settings/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.organization_external_application_settings -=================================================== +:py:mod:`abacusai.organization_external_application_settings` +============================================================= .. py:module:: abacusai.organization_external_application_settings -Classes -------- - -.. autoapisummary:: - - abacusai.organization_external_application_settings.AbstractApiClass - abacusai.organization_external_application_settings.OrganizationExternalApplicationSettings - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.organization_external_application_settings.OrganizationExternalApplicationSettings - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: OrganizationExternalApplicationSettings(client, logo=None, theme=None, managedUserService=None, passwordsDisabled=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` The External Application Settings for an Organization. @@ -45,13 +35,11 @@ Module Contents :param passwordsDisabled: Whether or not passwords are disabled for this organization's domain. :type passwordsDisabled: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/organization_group/index.rst.txt b/docs/_sources/autoapi/abacusai/organization_group/index.rst.txt index 4a8eeed07..f5739a95c 100644 --- a/docs/_sources/autoapi/abacusai/organization_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/organization_group/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.organization_group -=========================== +:py:mod:`abacusai.organization_group` +===================================== .. py:module:: abacusai.organization_group -Classes -------- - -.. autoapisummary:: - - abacusai.organization_group.AbstractApiClass - abacusai.organization_group.OrganizationGroup - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.organization_group.OrganizationGroup - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: OrganizationGroup(client, organizationGroupId=None, permissions=None, groupName=None, defaultGroup=None, admin=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An Organization Group. Defines the permissions available to the users who are members of the group. @@ -49,13 +39,11 @@ Module Contents :param createdAt: When the Organization Group was created. :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -64,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -73,7 +60,6 @@ Module Contents :rtype: OrganizationGroup - .. py:method:: describe() Returns the specific organization group passed in by the user. @@ -85,7 +71,6 @@ Module Contents :rtype: OrganizationGroup - .. py:method:: add_permission(permission) Adds a permission to the specified Organization Group. @@ -94,7 +79,6 @@ Module Contents :type permission: str - .. py:method:: remove_permission(permission) Removes a permission from the specified Organization Group. @@ -103,7 +87,6 @@ Module Contents :type permission: str - .. py:method:: delete() Deletes the specified Organization Group @@ -112,7 +95,6 @@ Module Contents :type organization_group_id: str - .. py:method:: add_user_to(email) Adds a user to the specified Organization Group. @@ -121,7 +103,6 @@ Module Contents :type email: str - .. py:method:: remove_user_from(email) Removes a user from an Organization Group. @@ -130,7 +111,6 @@ Module Contents :type email: str - .. py:method:: set_default() Sets the default Organization Group to which all new users joining an organization are automatically added. diff --git a/docs/_sources/autoapi/abacusai/organization_search_result/index.rst.txt b/docs/_sources/autoapi/abacusai/organization_search_result/index.rst.txt index ec8192048..4658e68c8 100644 --- a/docs/_sources/autoapi/abacusai/organization_search_result/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/organization_search_result/index.rst.txt @@ -1,1544 +1,26 @@ -abacusai.organization_search_result -=================================== +:py:mod:`abacusai.organization_search_result` +============================================= .. py:module:: abacusai.organization_search_result -Classes -------- - -.. autoapisummary:: - - abacusai.organization_search_result.FeatureGroup - abacusai.organization_search_result.FeatureGroupVersion - abacusai.organization_search_result.AbstractApiClass - abacusai.organization_search_result.OrganizationSearchResult - - -Module Contents ---------------- - -.. py:class:: FeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: Unique identifier for this feature group. - :type featureGroupId: str - :param modificationLock: If feature group is locked against a change or not. - :type modificationLock: bool - :param name: - :type name: str - :param featureGroupSourceType: The source type of the feature group - :type featureGroupSourceType: str - :param tableName: Unique table name of this feature group. - :type tableName: str - :param sql: SQL definition creating this feature group. - :type sql: str - :param datasetId: Dataset ID the feature group is sourced from. - :type datasetId: str - :param functionSourceCode: Source definition creating this feature group. - :type functionSourceCode: str - :param functionName: Function name to execute from the source code. - :type functionName: str - :param sourceTables: Source tables for this feature group. - :type sourceTables: list[str] - :param createdAt: Timestamp at which the feature group was created. - :type createdAt: str - :param description: Description of the feature group. - :type description: str - :param sqlError: Error message with this feature group. - :type sqlError: str - :param latestVersionOutdated: Is latest materialized feature group version outdated. - :type latestVersionOutdated: bool - :param referencedFeatureGroups: Feature groups this feature group is used in. - :type referencedFeatureGroups: list[str] - :param tags: Tags added to this feature group. - :type tags: list[str] - :param primaryKey: Primary index feature. - :type primaryKey: str - :param updateTimestampKey: Primary timestamp feature. - :type updateTimestampKey: str - :param lookupKeys: Additional indexed features for this feature group. - :type lookupKeys: list[str] - :param streamingEnabled: If true, the feature group can have data streamed to it. - :type streamingEnabled: bool - :param incremental: If feature group corresponds to an incremental dataset. - :type incremental: bool - :param mergeConfig: Merge configuration settings for the feature group. - :type mergeConfig: dict - :param operatorConfig: Operator configuration settings for the feature group. - :type operatorConfig: dict - :param samplingConfig: Sampling configuration for the feature group. - :type samplingConfig: dict - :param cpuSize: CPU size specified for the Python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the Python feature group. - :type memory: int - :param streamingReady: If true, the feature group is ready to receive streaming data. - :type streamingReady: bool - :param featureTags: Tags for features in this feature group - :type featureTags: dict - :param moduleName: Path to the file with the feature group function. - :type moduleName: str - :param templateBindings: Config specifying variable names and values to use when resolving a feature group template. - :type templateBindings: dict - :param featureExpression: If the dataset feature group has custom features, the SQL select expression creating those features. - :type featureExpression: str - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: dict - :param pythonFunctionName: Name of the Python function the feature group was built from. - :type pythonFunctionName: str - :param useGpu: Whether this feature group is using gpu - :type useGpu: bool - :param features: List of resolved features. - :type features: Feature - :param duplicateFeatures: List of duplicate features. - :type duplicateFeatures: Feature - :param pointInTimeGroups: List of Point In Time Groups. - :type pointInTimeGroups: PointInTimeGroup - :param annotationConfig: Annotation config for this feature - :type annotationConfig: AnnotationConfig - :param latestFeatureGroupVersion: Latest feature group version. - :type latestFeatureGroupVersion: FeatureGroupVersion - :param concatenationConfig: Feature group ID whose data will be concatenated into this feature group. - :type concatenationConfig: ConcatenationConfig - :param indexingConfig: Indexing config for the feature group for feature store - :type indexingConfig: IndexingConfig - :param codeSource: If a Python feature group, information on the source code. - :type codeSource: CodeSource - :param featureGroupTemplate: FeatureGroupTemplate to use when this feature group is attached to a template. - :type featureGroupTemplate: FeatureGroupTemplate - :param explanation: Natural language explanation of the feature group - :type explanation: NaturalLanguageExplanation - :param refreshSchedules: List of schedules that determines when the next version of the feature group will be created. - :type refreshSchedules: RefreshSchedule - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: add_to_project(project_id, feature_group_type = 'CUSTOM_TABLE') - - Adds a feature group to a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - :param feature_group_type: The feature group type of the feature group, based on the use case under which the feature group is being created. - :type feature_group_type: str - - - - .. py:method:: set_project_config(project_id, project_config = None) - - Sets a feature group's project config - - :param project_id: Unique string identifier for the project. - :type project_id: str - :param project_config: Feature group's project configuration. - :type project_config: ProjectFeatureGroupConfig - - - - .. py:method:: get_project_config(project_id) - - Gets a feature group's project config - - :param project_id: Unique string identifier for the project. - :type project_id: str - - :returns: The feature group's project configuration. - :rtype: ProjectConfig - - - - .. py:method:: remove_from_project(project_id) - - Removes a feature group from a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - - - .. py:method:: set_type(project_id, feature_group_type = 'CUSTOM_TABLE') - - Update the feature group type in a project. The feature group must already be added to the project. - - :param project_id: Unique identifier associated with the project. - :type project_id: str - :param feature_group_type: The feature group type to set the feature group as. - :type feature_group_type: str - - - - .. py:method:: describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) - - Get the latest annotation entry for a given feature group, feature, and document. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - - :returns: The latest annotation entry for the given feature group, feature, document, and/or annotation key value. - :rtype: AnnotationEntry - - - - .. py:method:: verify_and_describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) - - Get the latest annotation entry for a given feature group, feature, and document along with verification information. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - - :returns: The latest annotation entry for the given feature group, feature, document, and/or annotation key value. Includes the verification information. - :rtype: AnnotationEntry - - - - .. py:method:: update_annotation_status(feature_name, status, doc_id = None, feature_group_row_identifier = None, save_metadata = False) - - Update the status of an annotation entry. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param status: The new status of the annotation. Must be one of the following: 'TODO', 'IN_PROGRESS', 'DONE'. - :type status: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - :param save_metadata: If True, save the metadata for the annotation entry. - :type save_metadata: bool - - :returns: The updated annotation entry. - :rtype: AnnotationEntry - - - - .. py:method:: get_document_to_annotate(project_id, feature_name, feature_group_row_identifier = None, get_previous = False) - - Get an available document that needs to be annotated for a annotation feature group. - - :param project_id: The ID of the project that the annotation is associated with. - :type project_id: str - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the primary key value. If provided, fetch the immediate next (or previous) available document. - :type feature_group_row_identifier: str - :param get_previous: If True, get the previous document instead of the next document. Applicable if feature_group_row_identifier is provided. - :type get_previous: bool - - :returns: The document to annotate. - :rtype: AnnotationDocument - - - - .. py:method:: get_annotations_status(feature_name = None, check_for_materialization = False) - - Get the status of the annotations for a given feature group and feature. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param check_for_materialization: If True, check if the feature group needs to be materialized before using for annotations. - :type check_for_materialization: bool - - :returns: The status of the annotations for the given feature group and feature. - :rtype: AnnotationsStatus - - - - .. py:method:: import_annotation_labels(file, annotation_type) - - Imports annotation labels from csv file. All valid values in the file will be imported as labels (including header row if present). - - :param file: The file to import. Must be a csv file. - :type file: io.TextIOBase - :param annotation_type: The type of the annotation. - :type annotation_type: str - - :returns: The annotation config for the feature group. - :rtype: AnnotationConfig - - - - .. py:method:: create_sampling(table_name, sampling_config, description = None) - - Creates a new Feature Group defined as a sample of rows from another Feature Group. - - For efficiency, sampling is approximate unless otherwise specified. (e.g. the number of rows may vary slightly from what was requested). - - - :param table_name: The unique name to be given to this sampling Feature Group. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param sampling_config: Dictionary defining the sampling method and its parameters. - :type sampling_config: SamplingConfig - :param description: A human-readable description of this Feature Group. - :type description: str - - :returns: The created Feature Group. - :rtype: FeatureGroup - - - - .. py:method:: set_sampling_config(sampling_config) - - Set a FeatureGroup’s sampling to the config values provided, so that the rows the FeatureGroup returns will be a sample of those it would otherwise have returned. - - :param sampling_config: A JSON string object specifying the sampling method and parameters specific to that sampling method. An empty sampling_config indicates no sampling. - :type sampling_config: SamplingConfig - - :returns: The updated FeatureGroup. - :rtype: FeatureGroup - - - - .. py:method:: set_merge_config(merge_config) - - Set a MergeFeatureGroup’s merge config to the values provided, so that the feature group only returns a bounded range of an incremental dataset. - - :param merge_config: JSON object string specifying the merge rule. An empty merge_config will default to only including the latest dataset version. - :type merge_config: MergeConfig - - :returns: The updated FeatureGroup. - :rtype: FeatureGroup - - - - .. py:method:: set_operator_config(operator_config) - - Set a OperatorFeatureGroup’s operator config to the values provided. - - :param operator_config: A dictionary object specifying the pre-defined operations. - :type operator_config: dict - - - - .. py:method:: set_schema(schema) - - Creates a new schema and points the feature group to the new feature group schema ID. - - :param schema: JSON string containing an array of objects with 'name' and 'dataType' properties. - :type schema: list - - - - .. py:method:: get_schema(project_id = None) - - Returns a schema for a given FeatureGroup in a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - :returns: A list of objects for each column in the specified feature group. - :rtype: list[Feature] - - - - .. py:method:: create_feature(name, select_expression) - - Creates a new feature in a Feature Group from a SQL select statement. - - :param name: The name of the feature to add. - :type name: str - :param select_expression: SQL SELECT expression to create the feature. - :type select_expression: str - - :returns: A Feature Group object with the newly added feature. - :rtype: FeatureGroup - - - - .. py:method:: add_tag(tag) - - Adds a tag to the feature group - - :param tag: The tag to add to the feature group. - :type tag: str - - - - .. py:method:: remove_tag(tag) - - Removes a tag from the specified feature group. - - :param tag: The tag to remove from the feature group. - :type tag: str - - - - .. py:method:: add_annotatable_feature(name, annotation_type) - - Add an annotatable feature in a Feature Group - - :param name: The name of the feature to add. - :type name: str - :param annotation_type: The type of annotation to set. - :type annotation_type: str - - :returns: The feature group after the feature has been set - :rtype: FeatureGroup - - - - .. py:method:: set_feature_as_annotatable_feature(feature_name, annotation_type, feature_group_row_identifier_feature = None, doc_id_feature = None) - - Sets an existing feature as an annotatable feature (Feature that can be annotated). - - :param feature_name: The name of the feature to set as annotatable. - :type feature_name: str - :param annotation_type: The type of annotation label to add. - :type annotation_type: str - :param feature_group_row_identifier_feature: The key value of the feature group row the annotation is on (cast to string) and uniquely identifies the feature group row. At least one of the doc_id or key value must be provided so that the correct annotation can be identified. - :type feature_group_row_identifier_feature: str - :param doc_id_feature: The name of the document ID feature. - :type doc_id_feature: str - - :returns: A feature group object with the newly added annotatable feature. - :rtype: FeatureGroup - - - - .. py:method:: set_annotation_status_feature(feature_name) - - Sets a feature as the annotation status feature for a feature group. - - :param feature_name: The name of the feature to set as the annotation status feature. - :type feature_name: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: unset_feature_as_annotatable_feature(feature_name) - - Unsets a feature as annotatable - - :param feature_name: The name of the feature to unset. - :type feature_name: str - - :returns: The feature group after unsetting the feature - :rtype: FeatureGroup - - - - .. py:method:: add_annotation_label(label_name, annotation_type, label_definition = None) - - Adds an annotation label - - :param label_name: The name of the label. - :type label_name: str - :param annotation_type: The type of the annotation to set. - :type annotation_type: str - :param label_definition: the definition of the label. - :type label_definition: str - - :returns: The feature group after adding the annotation label - :rtype: FeatureGroup - - - - .. py:method:: remove_annotation_label(label_name) - - Removes an annotation label - - :param label_name: The name of the label to remove. - :type label_name: str - - :returns: The feature group after adding the annotation label - :rtype: FeatureGroup - - - - .. py:method:: add_feature_tag(feature, tag) - - Adds a tag on a feature - - :param feature: The feature to set the tag on. - :type feature: str - :param tag: The tag to set on the feature. - :type tag: str - - - - .. py:method:: remove_feature_tag(feature, tag) - - Removes a tag from a feature - - :param feature: The feature to remove the tag from. - :type feature: str - :param tag: The tag to remove. - :type tag: str - - - - .. py:method:: create_nested_feature(nested_feature_name, table_name, using_clause, where_clause = None, order_clause = None) - - Creates a new nested feature in a feature group from a SQL statement. - - :param nested_feature_name: The name of the feature. - :type nested_feature_name: str - :param table_name: The table name of the feature group to nest. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param using_clause: The SQL join column or logic to join the nested table with the parent. - :type using_clause: str - :param where_clause: A SQL WHERE statement to filter the nested rows. - :type where_clause: str - :param order_clause: A SQL clause to order the nested rows. - :type order_clause: str - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: update_nested_feature(nested_feature_name, table_name = None, using_clause = None, where_clause = None, order_clause = None, new_nested_feature_name = None) - - Updates a previously existing nested feature in a feature group. - - :param nested_feature_name: The name of the feature to be updated. - :type nested_feature_name: str - :param table_name: The name of the table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param using_clause: The SQL join column or logic to join the nested table with the parent. - :type using_clause: str - :param where_clause: An SQL WHERE statement to filter the nested rows. - :type where_clause: str - :param order_clause: An SQL clause to order the nested rows. - :type order_clause: str - :param new_nested_feature_name: New name for the nested feature. - :type new_nested_feature_name: str - - :returns: A feature group object with the updated nested feature. - :rtype: FeatureGroup - - - - .. py:method:: delete_nested_feature(nested_feature_name) - - Delete a nested feature. - - :param nested_feature_name: The name of the feature to be deleted. - :type nested_feature_name: str - - :returns: A feature group object without the specified nested feature. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_feature(feature_name, history_table_name, aggregation_keys, timestamp_key, historical_timestamp_key, expression, lookback_window_seconds = None, lookback_window_lag_seconds = 0, lookback_count = None, lookback_until_position = 0) - - Creates a new point in time feature in a feature group using another historical feature group, window spec, and aggregate expression. - - We use the aggregation keys and either the lookbackWindowSeconds or the lookbackCount values to perform the window aggregation for every row in the current feature group. - - If the window is specified in seconds, then all rows in the history table which match the aggregation keys and with historicalTimeFeature greater than or equal to lookbackStartCount and less than the value of the current rows timeFeature are considered. An optional lookbackWindowLagSeconds (+ve or -ve) can be used to offset the current value of the timeFeature. If this value is negative, we will look at the future rows in the history table, so care must be taken to ensure that these rows are available in the online context when we are performing a lookup on this feature group. If the window is specified in counts, then we order the historical table rows aligning by time and consider rows from the window where the rank order is greater than or equal to lookbackCount and includes the row just prior to the current one. The lag is specified in terms of positions using lookbackUntilPosition. - - - :param feature_name: The name of the feature to create. - :type feature_name: str - :param history_table_name: The table name of the history table. - :type history_table_name: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param timestamp_key: Name of feature which contains the timestamp value for the point in time feature. - :type timestamp_key: str - :param historical_timestamp_key: Name of feature which contains the historical timestamp. - :type historical_timestamp_key: str - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param lookback_window_seconds: If window is specified in terms of time, number of seconds in the past from the current time for start of the window. - :type lookback_window_seconds: float - :param lookback_window_lag_seconds: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the "future" rows in the history table. - :type lookback_window_lag_seconds: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookback_until_position: int - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_feature(feature_name, history_table_name = None, aggregation_keys = None, timestamp_key = None, historical_timestamp_key = None, expression = None, lookback_window_seconds = None, lookback_window_lag_seconds = None, lookback_count = None, lookback_until_position = None, new_feature_name = None) - - Updates an existing Point-in-Time (PiT) feature in a feature group. See `createPointInTimeFeature` for detailed semantics. - - :param feature_name: The name of the feature. - :type feature_name: str - :param history_table_name: The table name of the history table. If not specified, we use the current table to do a self join. - :type history_table_name: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param timestamp_key: Name of the feature which contains the timestamp value for the PiT feature. - :type timestamp_key: str - :param historical_timestamp_key: Name of the feature which contains the historical timestamp. - :type historical_timestamp_key: str - :param expression: SQL Aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param lookback_window_seconds: If the window is specified in terms of time, the number of seconds in the past from the current time for the start of the window. - :type lookback_window_seconds: float - :param lookback_window_lag_seconds: Optional lag to offset the closest point for the window. If it is positive, we delay the start of the window. If it is negative, we are looking at the "future" rows in the history table. - :type lookback_window_lag_seconds: float - :param lookback_count: If the window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, we delay the start of the window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookback_until_position: int - :param new_feature_name: New name for the PiT feature. - :type new_feature_name: str - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_group(group_name, window_key, aggregation_keys, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = 0, lookback_count = None, lookback_until_position = 0) - - Create a Point-in-Time Group - - :param group_name: The name of the point in time group. - :type group_name: str - :param window_key: Name of feature to use for ordering the rows on the source table. - :type window_key: str - :param aggregation_keys: List of keys to perform on the source table for the window aggregation. - :type aggregation_keys: list - :param history_table_name: The table to use for aggregating, if not provided, the source table will be used. - :type history_table_name: str - :param history_window_key: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used. - :type history_window_key: str - :param history_aggregation_keys: List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys. - :type history_aggregation_keys: list - :param lookback_window: Number of seconds in the past from the current time for the start of the window. If 0, the lookback will include all rows. - :type lookback_window: float - :param lookback_window_lag: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, "future" rows in the history table are used. - :type lookback_window_lag: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, those many "future" rows in the history table are used. - :type lookback_until_position: int - - :returns: The feature group after the point in time group has been created. - :rtype: FeatureGroup - - - - .. py:method:: generate_point_in_time_features(group_name, columns, window_functions, prefix = None) - - Generates and adds PIT features given the selected columns to aggregate over, and the operations to include. - - :param group_name: Name of the point-in-time group. - :type group_name: str - :param columns: List of columns to generate point-in-time features for. - :type columns: list - :param window_functions: List of window functions to operate on. - :type window_functions: list - :param prefix: Prefix for generated features, defaults to group name - :type prefix: str - - :returns: Feature group object with newly added point-in-time features. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_group(group_name, window_key = None, aggregation_keys = None, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = None, lookback_count = None, lookback_until_position = None) - - Update Point-in-Time Group - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param window_key: Name of feature which contains the timestamp value for the point-in-time feature. - :type window_key: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param history_table_name: The table to use for aggregating, if not provided, the source table will be used. - :type history_table_name: str - :param history_window_key: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used. - :type history_window_key: str - :param history_aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys. - :type history_aggregation_keys: list - :param lookback_window: Number of seconds in the past from the current time for the start of the window. - :type lookback_window: float - :param lookback_window_lag: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, future rows in the history table are looked at. - :type lookback_window_lag: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, those many future rows in the history table are looked at. - :type lookback_until_position: int - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: delete_point_in_time_group(group_name) - - Delete point in time group - - :param group_name: The name of the point in time group. - :type group_name: str - - :returns: The feature group after the point in time group has been deleted. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_group_feature(group_name, name, expression) - - Create point in time group feature - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param name: The name of the feature to add to the point-in-time group. - :type name: str - :param expression: A SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_group_feature(group_name, name, expression) - - Update a feature's SQL expression in a point in time group - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param name: The name of the feature to add to the point-in-time group. - :type name: str - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: set_feature_type(feature, feature_type, project_id = None) - - Set the type of a feature in a feature group. Specify the feature group ID, feature name, and feature type, and the method will return the new column with the changes reflected. - - :param feature: The name of the feature. - :type feature: str - :param feature_type: The machine learning type of the data in the feature. - :type feature_type: str - :param project_id: Optional unique ID associated with the project. - :type project_id: str - - :returns: The feature group after the data_type is applied. - :rtype: Schema - - - - .. py:method:: invalidate_streaming_data(invalid_before_timestamp) - - Invalidates all streaming data with timestamp before invalidBeforeTimestamp - - :param invalid_before_timestamp: Unix timestamp; any data with a timestamp before this time will be invalidated - :type invalid_before_timestamp: int - - - - .. py:method:: concatenate_data(source_feature_group_id, merge_type = 'UNION', replace_until_timestamp = None, skip_materialize = False) - - Concatenates data from one Feature Group to another. Feature Groups can be merged if their schemas are compatible, they have the special `updateTimestampKey` column, and (if set) the `primaryKey` column. The second operand in the concatenate operation will be appended to the first operand (merge target). - - :param source_feature_group_id: The Feature Group to concatenate with the destination Feature Group. - :type source_feature_group_id: str - :param merge_type: `UNION` or `INTERSECTION`. - :type merge_type: str - :param replace_until_timestamp: The UNIX timestamp to specify the point until which we will replace data from the source Feature Group. - :type replace_until_timestamp: int - :param skip_materialize: If `True`, will not materialize the concatenated Feature Group. - :type skip_materialize: bool - - - - .. py:method:: remove_concatenation_config() - - Removes the concatenation config on a destination feature group. - - :param feature_group_id: Unique identifier of the destination feature group to remove the concatenation configuration from. - :type feature_group_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroup - - - - .. py:method:: describe() - - Describe a Feature Group. - - :param feature_group_id: A unique string identifier associated with the feature group. - :type feature_group_id: str - - :returns: The feature group object. - :rtype: FeatureGroup - - - - .. py:method:: set_indexing_config(primary_key = None, update_timestamp_key = None, lookup_keys = None) - - Sets various attributes of the feature group used for primary key, deployment lookups and streaming updates. - - :param primary_key: Name of the feature which defines the primary key of the feature group. - :type primary_key: str - :param update_timestamp_key: Name of the feature which defines the update timestamp of the feature group. Used in concatenation and primary key deduplication. - :type update_timestamp_key: str - :param lookup_keys: List of feature names which can be used in the lookup API to restrict the computation to a set of dataset rows. These feature names have to correspond to underlying dataset columns. - :type lookup_keys: list - - - - .. py:method:: update(description = None) - - Modify an existing Feature Group. - - :param description: Description of the Feature Group. - :type description: str - - :returns: Updated Feature Group object. - :rtype: FeatureGroup - - - - .. py:method:: detach_from_template() - - Update a feature group to detach it from a template. - - :param feature_group_id: Unique string identifier associated with the feature group. - :type feature_group_id: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_template_bindings(template_bindings = None) - - Update the feature group template bindings for a template feature group. - - :param template_bindings: Values in these bindings override values set in the template. - :type template_bindings: list - - :returns: Updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_python_function_bindings(python_function_bindings) - - Updates an existing Feature Group's Python function bindings from a user-provided Python Function. If a list of feature groups are supplied within the Python function bindings, we will provide DataFrames (Pandas in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. - - :param python_function_bindings: List of python function arguments. - :type python_function_bindings: List - - - - .. py:method:: update_python_function(python_function_name, python_function_bindings = None, cpu_size = None, memory = None, use_gpu = None, use_original_csv_names = None) - - Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function - - bindings, we will provide as arguments to the function DataFrame's (pandas in the case of Python) with the materialized - feature groups for those input feature groups. - - - :param python_function_name: The name of the python function to be associated with the feature group. - :type python_function_name: str - :param python_function_bindings: List of python function arguments. - :type python_function_bindings: List - :param cpu_size: Size of the CPU for the feature group python function. - :type cpu_size: str - :param memory: Memory (in GB) for the feature group python function. - :type memory: int - :param use_gpu: Whether the feature group needs a gpu or not. Otherwise default to CPU. - :type use_gpu: bool - :param use_original_csv_names: If enabled, it uses the original column names for input feature groups from CSV datasets. - :type use_original_csv_names: bool - - - - .. py:method:: update_sql_definition(sql) - - Updates the SQL statement for a feature group. - - :param sql: The input SQL statement for the feature group. - :type sql: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_dataset_feature_expression(feature_expression) - - Updates the SQL feature expression for a Dataset FeatureGroup's custom features - - :param feature_expression: The input SQL statement for the feature group. - :type feature_expression: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_feature(name, select_expression = None, new_name = None) - - Modifies an existing feature in a feature group. - - :param name: Name of the feature to be updated. - :type name: str - :param select_expression: SQL statement for modifying the feature. - :type select_expression: str - :param new_name: New name of the feature. - :type new_name: str - - :returns: Updated feature group object. - :rtype: FeatureGroup - - - - .. py:method:: list_exports() - - Lists all of the feature group exports for the feature group - - :param feature_group_id: Unique identifier of the feature group - :type feature_group_id: str - - :returns: List of feature group exports - :rtype: list[FeatureGroupExport] - - - - .. py:method:: set_modifier_lock(locked = True) - - Lock a feature group to prevent modification. - - :param locked: Whether to disable or enable feature group modification (True or False). - :type locked: bool - - - - .. py:method:: list_modifiers() - - List the users who can modify a given feature group. - - :param feature_group_id: Unique string identifier of the feature group. - :type feature_group_id: str - - :returns: Information about the modification lock status and groups/organizations added to the feature group. - :rtype: ModificationLockInfo - - - - .. py:method:: add_user_to_modifiers(email) - - Adds a user to a feature group. - - :param email: The email address of the user to be added. - :type email: str - - - - .. py:method:: add_organization_group_to_modifiers(organization_group_id) - - Add OrganizationGroup to a feature group modifiers list - - :param organization_group_id: Unique string identifier of the organization group. - :type organization_group_id: str - - - - .. py:method:: remove_user_from_modifiers(email) - - Removes a user from a specified feature group. - - :param email: The email address of the user to be removed. - :type email: str - - - - .. py:method:: remove_organization_group_from_modifiers(organization_group_id) - - Removes an OrganizationGroup from a feature group modifiers list - - :param organization_group_id: The unique ID associated with the organization group. - :type organization_group_id: str - - - - .. py:method:: delete_feature(name) - - Removes a feature from the feature group. - - :param name: Name of the feature to be deleted. - :type name: str - - :returns: Updated feature group object. - :rtype: FeatureGroup - - - - .. py:method:: delete() - - Deletes a Feature Group. - - :param feature_group_id: Unique string identifier for the feature group to be removed. - :type feature_group_id: str - - - - .. py:method:: create_version(variable_bindings = None) - - Creates a snapshot for a specified feature group. Triggers materialization of the feature group. The new version of the feature group is created after it has materialized. - - :param variable_bindings: Dictionary defining variable bindings that override parent feature group values. - :type variable_bindings: dict - - :returns: A feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of all feature group versions for the specified feature group. - - :param limit: The maximum length of the returned versions. - :type limit: int - :param start_after_version: Results will start after this version. - :type start_after_version: str - - :returns: A list of feature group versions. - :rtype: list[FeatureGroupVersion] - - - - .. py:method:: create_template(name, template_sql, template_variables, description = None, template_bindings = None, should_attach_feature_group_to_template = False) - - Create a feature group template. - - :param name: User-friendly name for this feature group template. - :type name: str - :param template_sql: The template SQL that will be resolved by applying values from the template variables to generate SQL for a feature group. - :type template_sql: str - :param template_variables: The template variables for resolving the template. - :type template_variables: list - :param description: Description of this feature group template. - :type description: str - :param template_bindings: If the feature group will be attached to the newly created template, set these variable bindings on that feature group. - :type template_bindings: list - :param should_attach_feature_group_to_template: Set to `True` to convert the feature group to a template feature group and attach it to the newly created template. - :type should_attach_feature_group_to_template: bool - - :returns: The created feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: suggest_template_for() - - Suggest values for a feature gruop template, based on a feature group. - - :param feature_group_id: Unique identifier associated with the feature group to use for suggesting values to use in the template. - :type feature_group_id: str - - :returns: The suggested feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: get_recent_streamed_data() - - Returns recently streamed data to a streaming feature group. - - :param feature_group_id: Unique string identifier associated with the feature group. - :type feature_group_id: str - - - - .. py:method:: append_data(streaming_token, data) - - Appends new data into the feature group for a given lookup key recordId. - - :param streaming_token: The streaming token for authenticating requests. - :type streaming_token: str - :param data: The data to record as a JSON object. - :type data: dict - - - - .. py:method:: append_multiple_data(streaming_token, data) - - Appends new data into the feature group for a given lookup key recordId. - - :param streaming_token: Streaming token for authenticating requests. - :type streaming_token: str - :param data: Data to record, as a list of JSON objects. - :type data: list - - - - .. py:method:: upsert_data(data, streaming_token = None) - - Update new data into the feature group for a given lookup key record ID if the record ID is found; otherwise, insert new data into the feature group. - - :param data: The data to record, in JSON format. - :type data: dict - :param streaming_token: Optional streaming token for authenticating requests if upserting to streaming FG. - :type streaming_token: str - - :returns: The feature group row that was upserted. - :rtype: FeatureGroupRow - - - - .. py:method:: delete_data(primary_key) - - Deletes a row from the feature group given the primary key - - :param primary_key: The primary key value for which to delete the feature group row - :type primary_key: str - - - - .. py:method:: get_data(primary_key = None, num_rows = None) - - Gets the feature group rows for online updatable feature groups. - - If primary key is set, row corresponding to primary_key is returned. - If num_rows is set, we return maximum of num_rows latest updated rows. - - - :param primary_key: The primary key value for which to find the feature group row - :type primary_key: str - :param num_rows: Maximum number of rows to return from the feature group - :type num_rows: int - - :returns: A list of feature group rows. - :rtype: list[FeatureGroupRow] - - - - .. py:method:: get_natural_language_explanation(feature_group_version = None, model_id = None) - - Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model - - :param feature_group_version: A unique string identifier associated with the Feature Group Version. - :type feature_group_version: str - :param model_id: A unique string identifier associated with the Model. - :type model_id: str - - :returns: The object containing natural language explanation(s) as field(s). - :rtype: NaturalLanguageExplanation - - - - .. py:method:: generate_natural_language_explanation(feature_group_version = None, model_id = None) - - Generates natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model - - :param feature_group_version: A unique string identifier associated with the Feature Group Version. - :type feature_group_version: str - :param model_id: A unique string identifier associated with the Model. - :type model_id: str - - :returns: The object containing natural language explanation(s) as field(s). - :rtype: NaturalLanguageExplanation - - - - .. py:method:: wait_for_dataset(timeout = 7200) - - A waiting call until the feature group's dataset, if any, is ready for use. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_upload(timeout = 7200) - - Waits for a feature group created from a dataframe to be ready for materialization and version creation. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout = 7200) - - A waiting call until feature group is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_streaming_ready(timeout = 600) - - Waits for the feature group indexing config to be applied for streaming - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 600 seconds. - :type timeout: int - - - - .. py:method:: get_status(streaming_status = False) - - Gets the status of the feature group. - - :returns: A string describing the status of a feature group (pending, complete, etc.). - :rtype: str - - - - .. py:method:: load_as_pandas() - - Loads the feature groups into a python pandas dataframe. - - :returns: A pandas dataframe with annotations and text_snippet columns. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - - .. py:method:: describe_dataset() - - Displays the dataset attached to a feature group. - - :returns: A dataset object with all the relevant information about the dataset. - :rtype: Dataset - - - - .. py:method:: materialize() - - Materializes the feature group's latest change at the api call time. It'll skip materialization if no change since the current latest version. - - :returns: A feature group object with the lastest changes materialized. - :rtype: FeatureGroup - - - -.. py:class:: FeatureGroupVersion(client, featureGroupVersion=None, featureGroupId=None, sql=None, sourceTables=None, sourceDatasetVersions=None, createdAt=None, status=None, error=None, deployable=None, cpuSize=None, memory=None, useOriginalCsvNames=None, pythonFunctionBindings=None, indexingConfigWarningMsg=None, materializationStartedAt=None, materializationCompletedAt=None, columns=None, templateBindings=None, features={}, pointInTimeGroups={}, codeSource={}, annotationConfig={}, indexingConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A materialized version of a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupVersion: The unique identifier for this materialized version of feature group. - :type featureGroupVersion: str - :param featureGroupId: The unique identifier of the feature group this version belongs to. - :type featureGroupId: str - :param sql: The sql definition creating this feature group. - :type sql: str - :param sourceTables: The source tables for this feature group. - :type sourceTables: list[str] - :param sourceDatasetVersions: The dataset version ids for this feature group version. - :type sourceDatasetVersions: list[str] - :param createdAt: The timestamp at which the feature group version was created. - :type createdAt: str - :param status: The current status of the feature group version. - :type status: str - :param error: Relevant error if the status is FAILED. - :type error: str - :param deployable: whether feature group is deployable or not. - :type deployable: bool - :param cpuSize: Cpu size specified for the python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the python feature group. - :type memory: int - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: list - :param indexingConfigWarningMsg: The warning message related to indexing keys. - :type indexingConfigWarningMsg: str - :param materializationStartedAt: The timestamp at which the feature group materialization started. - :type materializationStartedAt: str - :param materializationCompletedAt: The timestamp at which the feature group materialization completed. - :type materializationCompletedAt: str - :param columns: List of resolved columns. - :type columns: list[feature] - :param templateBindings: Template variable bindings used for resolving the template. - :type templateBindings: list - :param features: List of features. - :type features: Feature - :param pointInTimeGroups: List of Point In Time Groups - :type pointInTimeGroups: PointInTimeGroup - :param codeSource: If a python feature group, information on the source code - :type codeSource: CodeSource - :param annotationConfig: The annotations config for the feature group. - :type annotationConfig: AnnotationConfig - :param indexingConfig: The indexing config for the feature group. - :type indexingConfig: IndexingConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: create_snapshot_feature_group(table_name) - - Creates a Snapshot Feature Group corresponding to a specific Feature Group version. - - :param table_name: Name for the newly created Snapshot Feature Group table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - - :returns: Feature Group corresponding to the newly created Snapshot. - :rtype: FeatureGroup - - - - .. py:method:: export_to_file_connector(location, export_file_format, overwrite = False) - - Export Feature group to File Connector. - - :param location: Cloud file location to export to. - :type location: str - :param export_file_format: Enum string specifying the file format to export to. - :type export_file_format: str - :param overwrite: If true and a file exists at this location, this process will overwrite the file. - :type overwrite: bool - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_database_connector(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) - - Export Feature group to Database Connector. - - :param database_connector_id: Unique string identifier for the Database Connector to export to. - :type database_connector_id: str - :param object_name: Name of the database object to write to. - :type object_name: str - :param write_mode: Enum string indicating whether to use INSERT or UPSERT. - :type write_mode: str - :param database_feature_mapping: Key/value pair JSON object of "database connector column" -> "feature name" pairs. - :type database_feature_mapping: dict - :param id_column: Required if write_mode is UPSERT. Indicates which database column should be used as the lookup key. - :type id_column: str - :param additional_id_columns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additional_id_columns: list - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_console(export_file_format) - - Export Feature group to console. - - :param export_file_format: File format to export to. - :type export_file_format: str - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: get_materialization_logs(stdout = False, stderr = False) - - Returns logs for a materialized feature group version. - - :param stdout: Set to True to get info logs. - :type stdout: bool - :param stderr: Set to True to get error logs. - :type stderr: bool - - :returns: A function logs object. - :rtype: FunctionLogs - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupVersion - - - - .. py:method:: describe() - - Describe a feature group version. - - :param feature_group_version: The unique identifier associated with the feature group version. - :type feature_group_version: str - - :returns: The feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) - - Get metrics for a specific feature group version. - - :param selected_columns: A list of columns to order first. - :type selected_columns: List - :param include_charts: A flag indicating whether charts should be included in the response. Default is false. - :type include_charts: bool - :param include_statistics: A flag indicating whether statistics should be included in the response. Default is true. - :type include_statistics: bool - - :returns: The metrics for the specified feature group version. - :rtype: DataMetrics - - - - .. py:method:: get_logs() - - Retrieves the feature group materialization logs. - - :param feature_group_version: The unique version ID of the feature group version. - :type feature_group_version: str - - :returns: The logs for the specified feature group version. - :rtype: FeatureGroupVersionLogs - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until feature group version is materialized - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout=3600) - - A waiting call until feature group version is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the feature group version. - - :returns: A string describing the status of a feature group version (pending, complete, etc.). - :rtype: str - - - - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) - - - .. py:method:: load_as_pandas(max_workers=10) - - Loads the feature group version into a pandas dataframe. - - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe displaying the data in the feature group version. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column, max_workers=10) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - -.. py:class:: AbstractApiClass(client, id) +Module Contents +--------------- - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.organization_search_result.OrganizationSearchResult - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: OrganizationSearchResult(client, score=None, featureGroupContext=None, featureGroup={}, featureGroupVersion={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A search result object which contains the retrieved artifact and its relevance score @@ -1553,13 +35,11 @@ Module Contents :param featureGroupVersion: The feature group version object retrieved through search. :type featureGroupVersion: FeatureGroupVersion - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/organization_secret/index.rst.txt b/docs/_sources/autoapi/abacusai/organization_secret/index.rst.txt index d6c16a9e7..1508a5595 100644 --- a/docs/_sources/autoapi/abacusai/organization_secret/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/organization_secret/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.organization_secret -============================ +:py:mod:`abacusai.organization_secret` +====================================== .. py:module:: abacusai.organization_secret -Classes -------- - -.. autoapisummary:: - - abacusai.organization_secret.AbstractApiClass - abacusai.organization_secret.OrganizationSecret - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.organization_secret.OrganizationSecret - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: OrganizationSecret(client, secretKey=None, value=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Organization secret @@ -43,13 +33,11 @@ Module Contents :param createdAt: The date and time when the secret was created, in ISO-8601 format. :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/page_data/index.rst.txt b/docs/_sources/autoapi/abacusai/page_data/index.rst.txt index 1109c60fe..6252a5ecc 100644 --- a/docs/_sources/autoapi/abacusai/page_data/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/page_data/index.rst.txt @@ -1,37 +1,27 @@ -abacusai.page_data -================== +:py:mod:`abacusai.page_data` +============================ .. py:module:: abacusai.page_data -Classes -------- - -.. autoapisummary:: - - abacusai.page_data.AbstractApiClass - abacusai.page_data.PageData - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) +Classes +~~~~~~~ - .. py:method:: __eq__(other) +.. autoapisummary:: - Return self==value. + abacusai.page_data.PageData - .. py:method:: _get_attribute_as_dict(attribute) +.. py:class:: PageData(client, docId=None, page=None, height=None, width=None, pageCount=None, pageText=None, pageTokenStartOffset=None, tokenCount=None, tokens=None, extractedText=None, rotationAngle=None, pageMarkdown=None, embeddedText=None) -.. py:class:: PageData(client, docId=None, page=None, height=None, width=None, pageCount=None, pageText=None, pageTokenStartOffset=None, tokenCount=None, tokens=None, extractedText=None, rotationAngle=None, pageMarkdown=None) Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - Data extracted from a docstore page. :param client: An authenticated API Client instance @@ -59,15 +49,15 @@ Module Contents :param rotationAngle: The detected rotation angle of the page in degrees. Positive values indicate clockwise and negative values indicate anti-clockwise rotation from the original orientation. :type rotationAngle: float :param pageMarkdown: The markdown text for the page. - :type pageMarkdown: list - + :type pageMarkdown: str + :param embeddedText: The embedded text in the page. Only available for digital documents. + :type embeddedText: str .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/pipeline/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline/index.rst.txt index adc7db20b..0d7292c60 100644 --- a/docs/_sources/autoapi/abacusai/pipeline/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline/index.rst.txt @@ -1,423 +1,26 @@ -abacusai.pipeline -================= +:py:mod:`abacusai.pipeline` +=========================== .. py:module:: abacusai.pipeline -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline.PythonFunctionArgument - abacusai.pipeline.CodeSource - abacusai.pipeline.PipelineReference - abacusai.pipeline.PipelineStep - abacusai.pipeline.PipelineVersion - abacusai.pipeline.AbstractApiClass - abacusai.pipeline.Pipeline - - Module Contents --------------- -.. py:class:: PythonFunctionArgument - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - A config class for python function arguments - - :param variable_type: The type of the python function argument - :type variable_type: PythonFunctionArgumentType - :param name: The name of the python function variable - :type name: str - :param is_required: Whether the argument is required - :type is_required: bool - :param value: The value of the argument - :type value: Any - :param pipeline_variable: The name of the pipeline variable to use as the value - :type pipeline_variable: str - - - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionArgumentType - - - .. py:attribute:: name - :type: str - - - .. py:attribute:: is_required - :type: bool - - - .. py:attribute:: value - :type: Any - - - .. py:attribute:: pipeline_variable - :type: str - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: PipelineReference(client, pipelineReferenceId=None, pipelineId=None, objectType=None, datasetId=None, modelId=None, deploymentId=None, batchPredictionDescriptionId=None, modelMonitorId=None, notebookId=None, featureGroupId=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A reference to a pipeline to the objects it is run on. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineReferenceId: The id of the reference. - :type pipelineReferenceId: str - :param pipelineId: The id of the pipeline for the reference. - :type pipelineId: str - :param objectType: The object type of the reference. - :type objectType: str - :param datasetId: The dataset id of the reference. - :type datasetId: str - :param modelId: The model id of the reference. - :type modelId: str - :param deploymentId: The deployment id of the reference. - :type deploymentId: str - :param batchPredictionDescriptionId: The batch prediction description id of the reference. - :type batchPredictionDescriptionId: str - :param modelMonitorId: The model monitor id of the reference. - :type modelMonitorId: str - :param notebookId: The notebook id of the reference. - :type notebookId: str - :param featureGroupId: The feature group id of the reference. - :type featureGroupId: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PipelineStep(client, pipelineStepId=None, pipelineId=None, stepName=None, pipelineName=None, createdAt=None, updatedAt=None, pythonFunctionId=None, stepDependencies=None, cpuSize=None, memory=None, timeout=None, pythonFunction={}, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A step in a pipeline. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineStepId: The reference to this step. - :type pipelineStepId: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param stepName: The name of the step. - :type stepName: str - :param pipelineName: The name of the pipeline this step is a part of. - :type pipelineName: str - :param createdAt: The date and time which this step was created. - :type createdAt: str - :param updatedAt: The date and time when this step was last updated. - :type updatedAt: str - :param pythonFunctionId: The python function_id. - :type pythonFunctionId: str - :param stepDependencies: List of steps this step depends on. - :type stepDependencies: list[str] - :param cpuSize: CPU size specified for the step function. - :type cpuSize: str - :param memory: Memory in GB specified for the step function. - :type memory: int - :param timeout: Timeout for the step in minutes, default is 300 minutes. - :type timeout: int - :param pythonFunction: Information about the python function for the step. - :type pythonFunction: PythonFunction - :param codeSource: Information about the source code of the step function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Deletes a step from a pipeline. - - :param pipeline_step_id: The ID of the pipeline step. - :type pipeline_step_id: str - - - - .. py:method:: update(function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) - - Creates a step in a given pipeline. - - :param function_name: The name of the Python function. - :type function_name: str - :param source_code: Contents of a valid Python source code file. The source code should contain the transform feature group functions. A list of allowed imports and system libraries for each language is specified in the user functions documentation section. - :type source_code: str - :param step_input_mappings: List of Python function arguments. - :type step_input_mappings: List - :param output_variable_mappings: List of Python function outputs. - :type output_variable_mappings: List - :param step_dependencies: List of step names this step depends on. - :type step_dependencies: list - :param package_requirements: List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']. - :type package_requirements: list - :param cpu_size: Size of the CPU for the step function. - :type cpu_size: str - :param memory: Memory (in GB) for the step function. - :type memory: int - :param timeout: Timeout for the pipeline step, default is 300 minutes. - :type timeout: int - - :returns: Object describing the pipeline. - :rtype: PipelineStep - - - - .. py:method:: rename(step_name) - - Renames a step in a given pipeline. - - :param step_name: The name of the step. - :type step_name: str - - :returns: Object describing the pipeline. - :rtype: PipelineStep - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PipelineStep - - - - .. py:method:: describe() - - Deletes a step from a pipeline. - - :param pipeline_step_id: The ID of the pipeline step. - :type pipeline_step_id: str - - :returns: An object describing the pipeline step. - :rtype: PipelineStep - - - -.. py:class:: PipelineVersion(client, pipelineName=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, completedAt=None, status=None, error=None, stepVersions={}, codeSource={}, pipelineVariableMappings={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a pipeline. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineName: The name of the pipeline this step is a part of. - :type pipelineName: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param pipelineVersion: The reference to this pipeline version. - :type pipelineVersion: str - :param createdAt: The date and time which this pipeline version was created. - :type createdAt: str - :param updatedAt: The date and time which this pipeline version was updated. - :type updatedAt: str - :param completedAt: The date and time which this pipeline version was updated. - :type completedAt: str - :param status: The status of the pipeline version. - :type status: str - :param error: The relevant error, if the status is FAILED. - :type error: str - :param stepVersions: A list of the pipeline step versions. - :type stepVersions: PipelineStepVersion - :param codeSource: information on the source code - :type codeSource: CodeSource - :param pipelineVariableMappings: A description of the function variables into the pipeline. - :type pipelineVariableMappings: PythonFunctionArgument - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PipelineVersion - - - - .. py:method:: describe() - - Describes a specified pipeline version - - :param pipeline_version: Unique string identifier for the pipeline version - :type pipeline_version: str - - :returns: Object describing the pipeline version - :rtype: PipelineVersion - - - - .. py:method:: reset(steps = None, include_downstream_steps = True) - - Reruns a pipeline version for the given steps and downstream steps if specified. - - :param steps: List of pipeline step names to rerun. - :type steps: list - :param include_downstream_steps: Whether to rerun downstream steps from the steps you have passed - :type include_downstream_steps: bool - - :returns: Object describing the pipeline version - :rtype: PipelineVersion - - - - .. py:method:: list_logs() - - Gets the logs for the steps in a given pipeline version. - - :param pipeline_version: The id of the pipeline version. - :type pipeline_version: str - - :returns: Object describing the logs for the steps in the pipeline. - :rtype: PipelineVersionLogs - - - - .. py:method:: skip_pending_steps() - - Skips pending steps in a pipeline version. - - :param pipeline_version: The id of the pipeline version. - :type pipeline_version: str - - :returns: Object describing the pipeline version - :rtype: PipelineVersion - - - - .. py:method:: wait_for_pipeline(timeout=1200) - - A waiting call until all the stages in a pipeline version have completed. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the pipeline version. - - :returns: A string describing the status of a pipeline version (pending, running, complete, etc.). - :rtype: str - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline.Pipeline - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Pipeline(client, pipelineName=None, pipelineId=None, createdAt=None, notebookId=None, cron=None, nextRunTime=None, isProd=None, warning=None, createdBy=None, steps={}, pipelineReferences={}, latestPipelineVersion={}, codeSource={}, pipelineVariableMappings={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Pipeline For Steps. @@ -452,13 +55,11 @@ Module Contents :param pipelineVariableMappings: A description of the function variables into the pipeline. :type pipelineVariableMappings: PythonFunctionArgument - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -467,7 +68,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -476,7 +76,6 @@ Module Contents :rtype: Pipeline - .. py:method:: describe() Describes a given pipeline. @@ -488,7 +87,6 @@ Module Contents :rtype: Pipeline - .. py:method:: update(project_id = None, pipeline_variable_mappings = None, cron = None, is_prod = None) Updates a pipeline for executing multiple steps. @@ -506,7 +104,6 @@ Module Contents :rtype: Pipeline - .. py:method:: rename(pipeline_name) Renames a pipeline. @@ -518,7 +115,6 @@ Module Contents :rtype: Pipeline - .. py:method:: delete() Deletes a pipeline. @@ -527,7 +123,6 @@ Module Contents :type pipeline_id: str - .. py:method:: list_versions(limit = 200) Lists the pipeline versions for a specified pipeline @@ -539,7 +134,6 @@ Module Contents :rtype: list[PipelineVersion] - .. py:method:: run(pipeline_variable_mappings = None) Runs a specified pipeline with the arguments provided. @@ -551,7 +145,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: create_step(step_name, function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) Creates a step in a given pipeline. @@ -581,7 +174,6 @@ Module Contents :rtype: Pipeline - .. py:method:: describe_step_by_name(step_name) Describes a pipeline step by the step name. @@ -593,7 +185,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: unset_refresh_schedule() Deletes the refresh schedule for a given pipeline. @@ -605,7 +196,6 @@ Module Contents :rtype: Pipeline - .. py:method:: pause_refresh_schedule() Pauses the refresh schedule for a given pipeline. @@ -617,7 +207,6 @@ Module Contents :rtype: Pipeline - .. py:method:: resume_refresh_schedule() Resumes the refresh schedule for a given pipeline. @@ -629,7 +218,6 @@ Module Contents :rtype: Pipeline - .. py:method:: create_step_from_function(step_name, function, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None) Creates a step in the pipeline from a python function. @@ -652,7 +240,6 @@ Module Contents :type memory: int - .. py:method:: wait_for_pipeline(timeout=1200) A waiting call until all the stages of the latest pipeline version is completed. @@ -661,7 +248,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the pipeline version. diff --git a/docs/_sources/autoapi/abacusai/pipeline_reference/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_reference/index.rst.txt index 93faf2376..18e7f0243 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_reference/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_reference/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.pipeline_reference -=========================== +:py:mod:`abacusai.pipeline_reference` +===================================== .. py:module:: abacusai.pipeline_reference -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_reference.AbstractApiClass - abacusai.pipeline_reference.PipelineReference - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_reference.PipelineReference - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineReference(client, pipelineReferenceId=None, pipelineId=None, objectType=None, datasetId=None, modelId=None, deploymentId=None, batchPredictionDescriptionId=None, modelMonitorId=None, notebookId=None, featureGroupId=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A reference to a pipeline to the objects it is run on. @@ -57,13 +47,11 @@ Module Contents :param featureGroupId: The feature group id of the reference. :type featureGroupId: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/pipeline_step/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_step/index.rst.txt index bc164abdc..00c914b9a 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_step/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_step/index.rst.txt @@ -1,165 +1,26 @@ -abacusai.pipeline_step -====================== +:py:mod:`abacusai.pipeline_step` +================================ .. py:module:: abacusai.pipeline_step -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_step.CodeSource - abacusai.pipeline_step.PythonFunction - abacusai.pipeline_step.AbstractApiClass - abacusai.pipeline_step.PipelineStep - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: PythonFunction(client, notebookId=None, name=None, createdAt=None, functionVariableMappings=None, outputVariableMappings=None, functionName=None, pythonFunctionId=None, functionType=None, packageRequirements=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Customer created python function - - :param client: An authenticated API Client instance - :type client: ApiClient - :param notebookId: The unique identifier of the notebook used to spin up the notebook upon creation. - :type notebookId: str - :param name: The name to identify the algorithm, only uppercase letters, numbers, and underscores allowed (i.e. it must be a valid Python identifier) - :type name: str - :param createdAt: The ISO-8601 string representing when the Python function was created. - :type createdAt: str - :param functionVariableMappings: A description of the function variables. - :type functionVariableMappings: dict - :param outputVariableMappings: A description of the variables returned by the function - :type outputVariableMappings: dict - :param functionName: The name of the Python function to be used. - :type functionName: str - :param pythonFunctionId: The unique identifier of the Python function. - :type pythonFunctionId: str - :param functionType: The type of the Python function. - :type functionType: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param codeSource: Information about the source code of the Python function. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: add_graph_to_dashboard(graph_dashboard_id, function_variable_mappings = None, name = None) - - Add a python plot function to a dashboard - - :param graph_dashboard_id: Unique string identifier for the graph dashboard to update. - :type graph_dashboard_id: str - :param function_variable_mappings: List of arguments to be supplied to the function as parameters, in the format [{'name': 'function_argument', 'variable_type': 'FEATURE_GROUP', 'value': 'name_of_feature_group'}]. - :type function_variable_mappings: List - :param name: Name of the added python plot - :type name: str - - :returns: An object describing the graph dashboard. - :rtype: GraphDashboard - - - - .. py:method:: validate_locally(kwargs = None) - - Validates a Python function by running it with the given input values in an local environment. Taking Input Feature Group as either name(string) or Pandas DataFrame in kwargs. - - :param kwargs: A dictionary mapping function arguments to values to pass to the function. Feature group names will automatically be converted into pandas dataframes. - :type kwargs: dict - - :returns: The result of executing the python function - :rtype: any - - :raises TypeError: If an Input Feature Group argument has an invalid type or argument is missing. - :raises Exception: If an error occurs while validating the Python function. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_step.PipelineStep - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineStep(client, pipelineStepId=None, pipelineId=None, stepName=None, pipelineName=None, createdAt=None, updatedAt=None, pythonFunctionId=None, stepDependencies=None, cpuSize=None, memory=None, timeout=None, pythonFunction={}, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A step in a pipeline. @@ -192,13 +53,11 @@ Module Contents :param codeSource: Information about the source code of the step function. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -207,7 +66,6 @@ Module Contents :rtype: dict - .. py:method:: delete() Deletes a step from a pipeline. @@ -216,7 +74,6 @@ Module Contents :type pipeline_step_id: str - .. py:method:: update(function_name = None, source_code = None, step_input_mappings = None, output_variable_mappings = None, step_dependencies = None, package_requirements = None, cpu_size = None, memory = None, timeout = None) Creates a step in a given pipeline. @@ -244,7 +101,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: rename(step_name) Renames a step in a given pipeline. @@ -256,7 +112,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -265,7 +120,6 @@ Module Contents :rtype: PipelineStep - .. py:method:: describe() Deletes a step from a pipeline. diff --git a/docs/_sources/autoapi/abacusai/pipeline_step_version/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_step_version/index.rst.txt index 627ccb596..7383c2922 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_step_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_step_version/index.rst.txt @@ -1,138 +1,26 @@ -abacusai.pipeline_step_version -============================== +:py:mod:`abacusai.pipeline_step_version` +======================================== .. py:module:: abacusai.pipeline_step_version -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_step_version.CodeSource - abacusai.pipeline_step_version.PipelineStepVersionReference - abacusai.pipeline_step_version.AbstractApiClass - abacusai.pipeline_step_version.PipelineStepVersion - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: PipelineStepVersionReference(client, pipelineStepVersionReferenceId=None, pipelineStepVersion=None, objectType=None, datasetVersion=None, modelVersion=None, deploymentVersion=None, batchPredictionId=None, modelMonitorVersion=None, notebookVersion=None, featureGroupVersion=None, status=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A reference from a pipeline step version to the versions that were output from the pipeline step. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param pipelineStepVersionReferenceId: The id of the reference. - :type pipelineStepVersionReferenceId: str - :param pipelineStepVersion: The pipeline step version the reference is connected to. - :type pipelineStepVersion: str - :param objectType: The object type of the reference. - :type objectType: str - :param datasetVersion: The dataset version the reference is connected to. - :type datasetVersion: str - :param modelVersion: The model version the reference is connected to. - :type modelVersion: str - :param deploymentVersion: The deployment version the reference is connected to. - :type deploymentVersion: str - :param batchPredictionId: The batch prediction id the reference is connected to. - :type batchPredictionId: str - :param modelMonitorVersion: The model monitor version the reference is connected to. - :type modelMonitorVersion: str - :param notebookVersion: The notebook version the reference is connected to. - :type notebookVersion: str - :param featureGroupVersion: The feature group version the reference is connected to. - :type featureGroupVersion: str - :param status: The status of the reference - :type status: str - :param error: The error message if the reference is in an error state. - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_step_version.PipelineStepVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineStepVersion(client, stepName=None, pipelineStepVersion=None, pipelineStepId=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, status=None, error=None, outputErrors=None, pythonFunctionId=None, functionVariableMappings=None, stepDependencies=None, outputVariableMappings=None, cpuSize=None, memory=None, timeout=None, pipelineStepVersionReferences={}, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of a pipeline step. @@ -177,13 +65,11 @@ Module Contents :param codeSource: Information about the source code of the pipeline step version. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -192,7 +78,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -201,7 +86,6 @@ Module Contents :rtype: PipelineStepVersion - .. py:method:: describe() Describes a pipeline step version. @@ -213,7 +97,6 @@ Module Contents :rtype: PipelineStepVersion - .. py:method:: get_step_version_logs() Gets the logs for a given step version. diff --git a/docs/_sources/autoapi/abacusai/pipeline_step_version_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_step_version_logs/index.rst.txt index a97a3a05a..f300f26aa 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_step_version_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_step_version_logs/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.pipeline_step_version_logs -=================================== +:py:mod:`abacusai.pipeline_step_version_logs` +============================================= .. py:module:: abacusai.pipeline_step_version_logs -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_step_version_logs.AbstractApiClass - abacusai.pipeline_step_version_logs.PipelineStepVersionLogs - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_step_version_logs.PipelineStepVersionLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineStepVersionLogs(client, stepName=None, pipelineStepId=None, pipelineStepVersion=None, logs=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs for a given pipeline step version. @@ -45,13 +35,11 @@ Module Contents :param logs: The logs for both stdout and stderr of the step :type logs: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/pipeline_step_version_reference/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_step_version_reference/index.rst.txt index 3adf82e1c..acfdd7db4 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_step_version_reference/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_step_version_reference/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.pipeline_step_version_reference -======================================== +:py:mod:`abacusai.pipeline_step_version_reference` +================================================== .. py:module:: abacusai.pipeline_step_version_reference -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_step_version_reference.AbstractApiClass - abacusai.pipeline_step_version_reference.PipelineStepVersionReference - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_step_version_reference.PipelineStepVersionReference - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineStepVersionReference(client, pipelineStepVersionReferenceId=None, pipelineStepVersion=None, objectType=None, datasetVersion=None, modelVersion=None, deploymentVersion=None, batchPredictionId=None, modelMonitorVersion=None, notebookVersion=None, featureGroupVersion=None, status=None, error=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A reference from a pipeline step version to the versions that were output from the pipeline step. @@ -61,13 +51,11 @@ Module Contents :param error: The error message if the reference is in an error state. :type error: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/pipeline_version/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_version/index.rst.txt index 68084386f..7a7a30334 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_version/index.rst.txt @@ -1,225 +1,26 @@ -abacusai.pipeline_version -========================= +:py:mod:`abacusai.pipeline_version` +=================================== .. py:module:: abacusai.pipeline_version -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_version.PythonFunctionArgument - abacusai.pipeline_version.CodeSource - abacusai.pipeline_version.PipelineStepVersion - abacusai.pipeline_version.AbstractApiClass - abacusai.pipeline_version.PipelineVersion - - Module Contents --------------- -.. py:class:: PythonFunctionArgument - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - A config class for python function arguments - - :param variable_type: The type of the python function argument - :type variable_type: PythonFunctionArgumentType - :param name: The name of the python function variable - :type name: str - :param is_required: Whether the argument is required - :type is_required: bool - :param value: The value of the argument - :type value: Any - :param pipeline_variable: The name of the pipeline variable to use as the value - :type pipeline_variable: str - - - .. py:attribute:: variable_type - :type: abacusai.api_class.enums.PythonFunctionArgumentType - - - .. py:attribute:: name - :type: str - - - .. py:attribute:: is_required - :type: bool - - - .. py:attribute:: value - :type: Any - - - .. py:attribute:: pipeline_variable - :type: str - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: PipelineStepVersion(client, stepName=None, pipelineStepVersion=None, pipelineStepId=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, status=None, error=None, outputErrors=None, pythonFunctionId=None, functionVariableMappings=None, stepDependencies=None, outputVariableMappings=None, cpuSize=None, memory=None, timeout=None, pipelineStepVersionReferences={}, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A version of a pipeline step. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param stepName: The name of the step. - :type stepName: str - :param pipelineStepVersion: The reference to the pipeline step version. - :type pipelineStepVersion: str - :param pipelineStepId: The reference to this step. - :type pipelineStepId: str - :param pipelineId: The reference to the pipeline this step belongs to. - :type pipelineId: str - :param pipelineVersion: The reference to the pipeline version. - :type pipelineVersion: str - :param createdAt: The date and time which this step was created. - :type createdAt: str - :param updatedAt: The date and time when this step was last updated. - :type updatedAt: str - :param status: The status of the pipeline version. - :type status: str - :param error: The error message if the pipeline step failed. - :type error: str - :param outputErrors: The error message of a pipeline step's output. - :type outputErrors: str - :param pythonFunctionId: The reference to the python function - :type pythonFunctionId: str - :param functionVariableMappings: The mappings for function parameters' names. - :type functionVariableMappings: dict - :param stepDependencies: List of steps this step depends on. - :type stepDependencies: list[str] - :param outputVariableMappings: The mappings for the output variables to the step. - :type outputVariableMappings: dict - :param cpuSize: CPU size specified for the step function. - :type cpuSize: str - :param memory: Memory in GB specified for the step function. - :type memory: int - :param timeout: The timeout in minutes for the pipeline step. - :type timeout: int - :param pipelineStepVersionReferences: A list to the output instances of the pipeline step version. - :type pipelineStepVersionReferences: PipelineStepVersionReference - :param codeSource: Information about the source code of the pipeline step version. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: PipelineStepVersion - - - - .. py:method:: describe() - - Describes a pipeline step version. - - :param pipeline_step_version: The ID of the pipeline step version. - :type pipeline_step_version: str - - :returns: An object describing the pipeline step version. - :rtype: PipelineStepVersion - - - - .. py:method:: get_step_version_logs() - - Gets the logs for a given step version. - - :param pipeline_step_version: The id of the pipeline step version. - :type pipeline_step_version: str - - :returns: Object describing the pipeline step logs. - :rtype: PipelineStepVersionLogs - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_version.PipelineVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineVersion(client, pipelineName=None, pipelineId=None, pipelineVersion=None, createdAt=None, updatedAt=None, completedAt=None, status=None, error=None, stepVersions={}, codeSource={}, pipelineVariableMappings={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of a pipeline. @@ -248,13 +49,11 @@ Module Contents :param pipelineVariableMappings: A description of the function variables into the pipeline. :type pipelineVariableMappings: PythonFunctionArgument - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -263,7 +62,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -272,7 +70,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: describe() Describes a specified pipeline version @@ -284,7 +81,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: reset(steps = None, include_downstream_steps = True) Reruns a pipeline version for the given steps and downstream steps if specified. @@ -298,7 +94,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: list_logs() Gets the logs for the steps in a given pipeline version. @@ -310,7 +105,6 @@ Module Contents :rtype: PipelineVersionLogs - .. py:method:: skip_pending_steps() Skips pending steps in a pipeline version. @@ -322,7 +116,6 @@ Module Contents :rtype: PipelineVersion - .. py:method:: wait_for_pipeline(timeout=1200) A waiting call until all the stages in a pipeline version have completed. @@ -331,7 +124,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the pipeline version. diff --git a/docs/_sources/autoapi/abacusai/pipeline_version_logs/index.rst.txt b/docs/_sources/autoapi/abacusai/pipeline_version_logs/index.rst.txt index dc4d36f3c..3bc57bea2 100644 --- a/docs/_sources/autoapi/abacusai/pipeline_version_logs/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/pipeline_version_logs/index.rst.txt @@ -1,71 +1,26 @@ -abacusai.pipeline_version_logs -============================== +:py:mod:`abacusai.pipeline_version_logs` +======================================== .. py:module:: abacusai.pipeline_version_logs -Classes -------- - -.. autoapisummary:: - - abacusai.pipeline_version_logs.PipelineStepVersionLogs - abacusai.pipeline_version_logs.AbstractApiClass - abacusai.pipeline_version_logs.PipelineVersionLogs - - Module Contents --------------- -.. py:class:: PipelineStepVersionLogs(client, stepName=None, pipelineStepId=None, pipelineStepVersion=None, logs=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Logs for a given pipeline step version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param stepName: The name of the step - :type stepName: str - :param pipelineStepId: The ID of the step - :type pipelineStepId: str - :param pipelineStepVersion: The version of the step - :type pipelineStepVersion: str - :param logs: The logs for both stdout and stderr of the step - :type logs: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.pipeline_version_logs.PipelineVersionLogs - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PipelineVersionLogs(client, stepLogs={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Logs for a given pipeline version. @@ -74,13 +29,11 @@ Module Contents :param stepLogs: A list of the pipeline step version logs. :type stepLogs: PipelineStepVersionLogs - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/point_in_time_feature/index.rst.txt b/docs/_sources/autoapi/abacusai/point_in_time_feature/index.rst.txt index eb0b780f2..9e29c0257 100644 --- a/docs/_sources/autoapi/abacusai/point_in_time_feature/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/point_in_time_feature/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.point_in_time_feature -============================== +:py:mod:`abacusai.point_in_time_feature` +======================================== .. py:module:: abacusai.point_in_time_feature -Classes -------- - -.. autoapisummary:: - - abacusai.point_in_time_feature.AbstractApiClass - abacusai.point_in_time_feature.PointInTimeFeature - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.point_in_time_feature.PointInTimeFeature - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PointInTimeFeature(client, historyTableName=None, aggregationKeys=None, timestampKey=None, historicalTimestampKey=None, lookbackWindowSeconds=None, lookbackWindowLagSeconds=None, lookbackCount=None, lookbackUntilPosition=None, expression=None, groupName=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A point-in-time feature description @@ -57,13 +47,11 @@ Module Contents :param groupName: The group name this point-in-time feature belongs to. :type groupName: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/point_in_time_feature_info/index.rst.txt b/docs/_sources/autoapi/abacusai/point_in_time_feature_info/index.rst.txt index 1d5dd7eea..1d4660f46 100644 --- a/docs/_sources/autoapi/abacusai/point_in_time_feature_info/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/point_in_time_feature_info/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.point_in_time_feature_info -=================================== +:py:mod:`abacusai.point_in_time_feature_info` +============================================= .. py:module:: abacusai.point_in_time_feature_info -Classes -------- - -.. autoapisummary:: - - abacusai.point_in_time_feature_info.AbstractApiClass - abacusai.point_in_time_feature_info.PointInTimeFeatureInfo - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.point_in_time_feature_info.PointInTimeFeatureInfo - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PointInTimeFeatureInfo(client, expression=None, groupName=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A point-in-time infos for a feature @@ -41,13 +31,11 @@ Module Contents :param groupName: The group name this point-in-time feature belongs to. :type groupName: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/point_in_time_group/index.rst.txt b/docs/_sources/autoapi/abacusai/point_in_time_group/index.rst.txt index 3d1b2ea0b..2aaeb22c2 100644 --- a/docs/_sources/autoapi/abacusai/point_in_time_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/point_in_time_group/index.rst.txt @@ -1,71 +1,26 @@ -abacusai.point_in_time_group -============================ +:py:mod:`abacusai.point_in_time_group` +====================================== .. py:module:: abacusai.point_in_time_group -Classes -------- - -.. autoapisummary:: - - abacusai.point_in_time_group.PointInTimeGroupFeature - abacusai.point_in_time_group.AbstractApiClass - abacusai.point_in_time_group.PointInTimeGroup - - Module Contents --------------- -.. py:class:: PointInTimeGroupFeature(client, name=None, expression=None, pitOperationType=None, pitOperationConfig=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point in time group feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The name of the feature - :type name: str - :param expression: SQL Aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param pitOperationType: The operation used in point in time feature generation - :type pitOperationType: str - :param pitOperationConfig: The configuration used as input to the operation type - :type pitOperationConfig: dict - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.point_in_time_group.PointInTimeGroup - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PointInTimeGroup(client, groupName=None, windowKey=None, aggregationKeys=None, lookbackWindow=None, lookbackWindowLag=None, lookbackCount=None, lookbackUntilPosition=None, historyTableName=None, historyWindowKey=None, historyAggregationKeys=None, features={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A point in time group containing point in time features @@ -94,13 +49,11 @@ Module Contents :param features: List of features in the Point in Time group :type features: PointInTimeGroupFeature - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/point_in_time_group_feature/index.rst.txt b/docs/_sources/autoapi/abacusai/point_in_time_group_feature/index.rst.txt index 04902e01b..605fbdf10 100644 --- a/docs/_sources/autoapi/abacusai/point_in_time_group_feature/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/point_in_time_group_feature/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.point_in_time_group_feature -==================================== +:py:mod:`abacusai.point_in_time_group_feature` +============================================== .. py:module:: abacusai.point_in_time_group_feature -Classes -------- - -.. autoapisummary:: - - abacusai.point_in_time_group_feature.AbstractApiClass - abacusai.point_in_time_group_feature.PointInTimeGroupFeature - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.point_in_time_group_feature.PointInTimeGroupFeature - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PointInTimeGroupFeature(client, name=None, expression=None, pitOperationType=None, pitOperationConfig=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A point in time group feature @@ -45,13 +35,11 @@ Module Contents :param pitOperationConfig: The configuration used as input to the operation type :type pitOperationConfig: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/prediction_client/index.rst.txt b/docs/_sources/autoapi/abacusai/prediction_client/index.rst.txt index ab158698e..f4372a9c7 100644 --- a/docs/_sources/autoapi/abacusai/prediction_client/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/prediction_client/index.rst.txt @@ -1,168 +1,32 @@ -abacusai.prediction_client -========================== +:py:mod:`abacusai.prediction_client` +==================================== .. py:module:: abacusai.prediction_client -Classes -------- - -.. autoapisummary:: - - abacusai.prediction_client.AgentDataExecutionResult - abacusai.prediction_client.BaseApiClient - abacusai.prediction_client.ClientOptions - abacusai.prediction_client.DocumentRetrieverLookupResult - abacusai.prediction_client.PredictionClient - - Module Contents --------------- -.. py:class:: AgentDataExecutionResult(client, response=None, deploymentConversationId=None, docInfos={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Results of agent execution with uploaded data. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param response: The result of agent conversation execution. - :type response: str - :param deploymentConversationId: The unique identifier of the deployment conversation. - :type deploymentConversationId: id - :param docInfos: A list of dict containing information on documents uploaded to agent. - :type docInfos: AgentDataDocumentInfo - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: BaseApiClient(api_key = None, server = None, client_options = None, skip_version_check = False) - - Abstract Base API Client - - :param api_key: The api key to use as authentication to the server - :type api_key: str - :param server: The base server url to use to send API requets to - :type server: str - :param client_options: Optional API client configurations - :type client_options: ClientOptions - :param skip_version_check: If true, will skip checking the server's current API version on initializing the client - :type skip_version_check: bool - - - .. py:attribute:: client_version - :value: '1.3.2' - - - - .. py:method:: _get_prediction_endpoint(deployment_id, deployment_token) - - - .. py:method:: _get_proxy_endpoint(deployment_id, deployment_token) - - - .. py:method:: _get_streaming_endpoint(streaming_token, model_id = None, feature_group_id = None) - - - .. py:method:: _clean_api_objects(obj) - - - .. py:method:: _call_api(action, method, query_params=None, body=None, files=None, parse_type=None, streamable_response=False, server_override=None, timeout=None, retry_500 = False, data=None) - - - .. py:method:: _proxy_request(name, method = 'POST', query_params = None, body = None, files=None, parse_type=None, is_sync = False, streamable_response = False) - - - .. py:method:: _build_class(return_class, values) - - - .. py:method:: _request(url, method, query_params=None, headers=None, body=None, files=None, stream=False, timeout=None, retry_500 = False, data=None) - - - .. py:method:: _poll(obj, wait_states, delay = 15, timeout = 300, poll_args = {}, status_field=None) - - - .. py:method:: _validate_pandas_df(df, clean_column_names) - - - .. py:method:: _upload_from_pandas(upload, df, clean_column_names=False) - - - .. py:method:: _upload_from_spark(upload, df) - - -.. py:class:: ClientOptions(exception_on_404 = True, server = DEFAULT_SERVER) - - Options for configuring the ApiClient - - :param exception_on_404: If true, will raise an exception on a 404 from the server, else will return None. - :type exception_on_404: bool - :param server: The default server endpoint to use for API requests - :type server: str - - -.. py:class:: DocumentRetrieverLookupResult(client, document=None, score=None, properties=None, pages=None, boundingBoxes=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Result of a document retriever lookup. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param document: The document that was looked up. - :type document: str - :param score: Score of the document with respect to the query. - :type score: float - :param properties: Properties of the retrieved documents. - :type properties: dict - :param pages: Pages of the retrieved text from the original document. - :type pages: list - :param boundingBoxes: Bounding boxes of the retrieved text from the original document. - :type boundingBoxes: list - - - .. py:method:: __repr__() - - Return repr(self). - - +Classes +~~~~~~~ - .. py:method:: to_dict() +.. autoapisummary:: - Get a dict representation of the parameters in this class + abacusai.prediction_client.PredictionClient - :returns: The dict value representation of the class parameters - :rtype: dict .. py:class:: PredictionClient(client_options = None) - Bases: :py:obj:`abacusai.client.BaseApiClient` + Bases: :py:obj:`abacusai.client.BaseApiClient` Abacus.AI Prediction API Client. Does not utilize authentication and only contains public prediction methods :param client_options: Optional API client configurations :type client_options: ClientOptions - .. py:method:: predict_raw(deployment_token, deployment_id, **kwargs) Raw interface for returning predictions from Plug and Play deployments. @@ -175,7 +39,6 @@ Module Contents :type \*\*kwargs: dict - .. py:method:: lookup_features(deployment_token, deployment_id, query_data, limit_results = None, result_columns = None) Returns the feature group deployed in the feature store project. @@ -192,7 +55,6 @@ Module Contents :type result_columns: list - .. py:method:: predict(deployment_token, deployment_id, query_data) Returns a prediction for Predictive Modeling @@ -205,7 +67,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_multiple(deployment_token, deployment_id, query_data) Returns a list of predictions for predictive modeling. @@ -218,7 +79,6 @@ Module Contents :type query_data: list - .. py:method:: predict_from_datasets(deployment_token, deployment_id, query_data) Returns a list of predictions for Predictive Modeling. @@ -231,7 +91,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_lead(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user being a lead based on their interaction with the service/product and their own attributes (e.g. income, assets, credit score, etc.). Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'user_id' mapped to mapping 'LEAD_ID' in our system). @@ -248,7 +107,6 @@ Module Contents :type explainer_type: str - .. py:method:: predict_churn(deployment_token, deployment_id, query_data, explain_predictions = False, explainer_type = None) Returns the probability of a user to churn out in response to their interactions with the item/product/service. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'churn_result' mapped to mapping 'CHURNED_YN' in our system). @@ -265,7 +123,6 @@ Module Contents :type explainer_type: str - .. py:method:: predict_takeover(deployment_token, deployment_id, query_data) Returns a probability for each class label associated with the types of fraud or a 'yes' or 'no' type label for the possibility of fraud. Note that the inputs to this method, wherever applicable, will be the column names in the dataset mapped to the column mappings in our system (e.g., column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -278,7 +135,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_fraud(deployment_token, deployment_id, query_data) Returns the probability of a transaction performed under a specific account being fraudulent or not. Note that the inputs to this method, wherever applicable, should be the column names in your dataset mapped to the column mappings in our system (e.g. column 'account_number' mapped to the mapping 'ACCOUNT_ID' in our system). @@ -291,7 +147,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_class(deployment_token, deployment_id, query_data, threshold = None, threshold_class = None, thresholds = None, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a classification prediction @@ -318,7 +173,6 @@ Module Contents :type explainer_type: str - .. py:method:: predict_target(deployment_token, deployment_id, query_data, explain_predictions = False, fixed_features = None, nested = None, explainer_type = None) Returns a prediction from a classification or regression model. Optionally, includes explanations. @@ -339,7 +193,6 @@ Module Contents :type explainer_type: str - .. py:method:: get_anomalies(deployment_token, deployment_id, threshold = None, histogram = False) Returns a list of anomalies from the training dataset. @@ -354,7 +207,6 @@ Module Contents :type histogram: bool - .. py:method:: get_timeseries_anomalies(deployment_token, deployment_id, start_timestamp = None, end_timestamp = None, query_data = None, get_all_item_data = False, series_ids = None) Returns a list of anomalous timestamps from the training dataset. @@ -375,7 +227,6 @@ Module Contents :type series_ids: list - .. py:method:: is_anomaly(deployment_token, deployment_id, query_data = None) Returns a list of anomaly attributes based on login information for a specified account. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'account_name' mapped to mapping 'ACCOUNT_ID' in our system). @@ -388,7 +239,6 @@ Module Contents :type query_data: dict - .. py:method:: get_event_anomaly_score(deployment_token, deployment_id, query_data = None) Returns an anomaly score for an event. @@ -401,7 +251,6 @@ Module Contents :type query_data: dict - .. py:method:: get_forecast(deployment_token, deployment_id, query_data, future_data = None, num_predictions = None, prediction_start = None, explain_predictions = False, explainer_type = None, get_item_data = False) Returns a list of forecasts for a given entity under the specified project deployment. Note that the inputs to the deployed model will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'holiday_yn' mapped to mapping 'FUTURE' in our system). @@ -426,7 +275,6 @@ Module Contents :type get_item_data: bool - .. py:method:: get_k_nearest(deployment_token, deployment_id, vector, k = None, distance = None, include_score = False, catalog_id = None) Returns the k nearest neighbors for the provided embedding vector. @@ -447,7 +295,6 @@ Module Contents :type catalog_id: str - .. py:method:: get_multiple_k_nearest(deployment_token, deployment_id, queries) Returns the k nearest neighbors for the queries provided. @@ -460,7 +307,6 @@ Module Contents :type queries: list - .. py:method:: get_labels(deployment_token, deployment_id, query_data, return_extracted_entities = False) Returns a list of scored labels for a document. @@ -475,7 +321,6 @@ Module Contents :type return_extracted_entities: bool - .. py:method:: get_entities_from_pdf(deployment_token, deployment_id, pdf = None, doc_id = None, return_extracted_features = False, verbose = False, save_extracted_features = None) Extracts text from the provided PDF and returns a list of recognized labels and their scores. @@ -496,7 +341,6 @@ Module Contents :type save_extracted_features: bool - .. py:method:: get_recommendations(deployment_token, deployment_id, query_data, num_items = None, page = None, exclude_item_ids = None, score_field = None, scaling_factors = None, restrict_items = None, exclude_items = None, explore_fraction = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of recommendations for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'time' mapped to mapping 'TIMESTAMP' in our system). @@ -527,7 +371,6 @@ Module Contents :type diversity_max_results_per_value: int - .. py:method:: get_personalized_ranking(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, scaling_factors = None) Returns a list of items with personalized promotions for a given user under the specified project deployment. Note that the inputs to this method, wherever applicable, should be the column names in the dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -546,7 +389,6 @@ Module Contents :type scaling_factors: list - .. py:method:: get_ranked_items(deployment_token, deployment_id, query_data, preserve_ranks = None, preserve_unknown_items = False, score_field = None, scaling_factors = None, diversity_attribute_name = None, diversity_max_results_per_value = None) Returns a list of re-ranked items for a selected user when a list of items is required to be reranked according to the user's preferences. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -571,7 +413,6 @@ Module Contents :type diversity_max_results_per_value: int - .. py:method:: get_related_items(deployment_token, deployment_id, query_data, num_items = None, page = None, scaling_factors = None, restrict_items = None, exclude_items = None) Returns a list of related items for a given item under the specified project deployment. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'item_code' mapped to mapping 'ITEM_ID' in our system). @@ -594,7 +435,6 @@ Module Contents :type exclude_items: list - .. py:method:: get_chat_response(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False) Return a chat response which continues the conversation based on the input messages and search results. @@ -623,7 +463,6 @@ Module Contents :type ignore_documents: bool - .. py:method:: get_chat_response_with_binary_data(deployment_token, deployment_id, messages, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a chat response which continues the conversation based on the input messages and search results. @@ -654,7 +493,6 @@ Module Contents :type attachments: None - .. py:method:: get_conversation_response(deployment_id, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, deployment_token = None, doc_infos = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -689,7 +527,6 @@ Module Contents :type doc_infos: list - .. py:method:: get_conversation_response_with_binary_data(deployment_id, deployment_token, message, deployment_conversation_id = None, external_session_id = None, llm_name = None, num_completion_tokens = None, system_message = None, temperature = 0.0, filter_key_values = None, search_score_cutoff = None, chat_config = None, ignore_documents = False, attachments = None) Return a conversation response which continues the conversation based on the input message and deployment conversation id (if exists). @@ -724,7 +561,6 @@ Module Contents :type attachments: None - .. py:method:: get_search_results(deployment_token, deployment_id, query_data, num = 15) Return the most relevant search results to the search query from the uploaded documents. @@ -739,7 +575,6 @@ Module Contents :type num: int - .. py:method:: get_sentiment(deployment_token, deployment_id, document) Predicts sentiment on a document @@ -752,7 +587,6 @@ Module Contents :type document: str - .. py:method:: get_entailment(deployment_token, deployment_id, document) Predicts the classification of the document @@ -765,7 +599,6 @@ Module Contents :type document: str - .. py:method:: get_classification(deployment_token, deployment_id, document) Predicts the classification of the document @@ -778,7 +611,6 @@ Module Contents :type document: str - .. py:method:: get_summary(deployment_token, deployment_id, query_data) Returns a JSON of the predicted summary for the given document. Note that the inputs to this method, wherever applicable, will be the column names in your dataset mapped to the column mappings in our system (e.g. column 'text' mapped to mapping 'DOCUMENT' in our system). @@ -791,7 +623,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_language(deployment_token, deployment_id, query_data) Predicts the language of the text @@ -804,7 +635,6 @@ Module Contents :type query_data: str - .. py:method:: get_assignments(deployment_token, deployment_id, query_data, forced_assignments = None, solve_time_limit_seconds = None, include_all_assignments = False) Get all positive assignments that match a query. @@ -823,7 +653,6 @@ Module Contents :type include_all_assignments: bool - .. py:method:: get_alternative_assignments(deployment_token, deployment_id, query_data, add_constraints = None, solve_time_limit_seconds = None, best_alternate_only = False) Get alternative positive assignments for given query. Optimal assignments are ignored and the alternative assignments are returned instead. @@ -842,7 +671,6 @@ Module Contents :type best_alternate_only: bool - .. py:method:: check_constraints(deployment_token, deployment_id, query_data) Check for any constraints violated by the overrides. @@ -855,7 +683,6 @@ Module Contents :type query_data: dict - .. py:method:: predict_with_binary_data(deployment_token, deployment_id, blob) Make predictions for a given blob, e.g. image, audio @@ -868,7 +695,6 @@ Module Contents :type blob: io.TextIOBase - .. py:method:: describe_image(deployment_token, deployment_id, image, categories, top_n = None) Describe the similarity between an image and a list of categories. @@ -885,7 +711,6 @@ Module Contents :type top_n: int - .. py:method:: get_text_from_document(deployment_token, deployment_id, document = None, adjust_doc_orientation = False, save_predicted_pdf = False, save_extracted_features = False) Generate text from a document @@ -904,7 +729,6 @@ Module Contents :type save_extracted_features: bool - .. py:method:: transcribe_audio(deployment_token, deployment_id, audio) Transcribe the audio @@ -917,7 +741,6 @@ Module Contents :type audio: io.TextIOBase - .. py:method:: classify_image(deployment_token, deployment_id, image = None, doc_id = None) Classify an image. @@ -932,7 +755,6 @@ Module Contents :type doc_id: str - .. py:method:: classify_pdf(deployment_token, deployment_id, pdf = None) Returns a classification prediction from a PDF @@ -945,7 +767,6 @@ Module Contents :type pdf: io.TextIOBase - .. py:method:: get_cluster(deployment_token, deployment_id, query_data) Predicts the cluster for given data. @@ -958,7 +779,6 @@ Module Contents :type query_data: dict - .. py:method:: get_objects_from_image(deployment_token, deployment_id, image) Classify an image. @@ -971,7 +791,6 @@ Module Contents :type image: io.TextIOBase - .. py:method:: score_image(deployment_token, deployment_id, image) Score on image. @@ -984,7 +803,6 @@ Module Contents :type image: io.TextIOBase - .. py:method:: transfer_style(deployment_token, deployment_id, source_image, style_image) Change the source image to adopt the visual style from the style image. @@ -999,7 +817,6 @@ Module Contents :type style_image: io.TextIOBase - .. py:method:: generate_image(deployment_token, deployment_id, query_data) Generate an image from text prompt. @@ -1012,7 +829,6 @@ Module Contents :type query_data: dict - .. py:method:: execute_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -1027,7 +843,6 @@ Module Contents :type keyword_arguments: dict - .. py:method:: execute_conversation_agent(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, regenerate = False, doc_infos = None) Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function. @@ -1050,7 +865,6 @@ Module Contents :type doc_infos: list - .. py:method:: lookup_matches(deployment_token, deployment_id, data = None, filters = None, num = None, result_columns = None, max_words = None, num_retrieval_margin_words = None, max_words_per_chunk = None, score_multiplier_column = None, min_score = None, required_phrases = None, filter_clause = None, crowding_limits = None) Lookup document retrievers and return the matching documents from the document retriever deployed with given query. @@ -1093,7 +907,6 @@ Module Contents :rtype: list[DocumentRetrieverLookupResult] - .. py:method:: get_completion(deployment_token, deployment_id, prompt) Returns the finetuned LLM generated completion of the prompt. @@ -1106,7 +919,6 @@ Module Contents :type prompt: str - .. py:method:: execute_agent_with_binary_data(deployment_token, deployment_id, arguments = None, keyword_arguments = None, deployment_conversation_id = None, external_session_id = None, blobs = None) Executes a deployed AI agent function with binary data as inputs. diff --git a/docs/_sources/autoapi/abacusai/prediction_dataset/index.rst.txt b/docs/_sources/autoapi/abacusai/prediction_dataset/index.rst.txt index f3aaf7b0e..129ff70ad 100644 --- a/docs/_sources/autoapi/abacusai/prediction_dataset/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/prediction_dataset/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.prediction_dataset -=========================== +:py:mod:`abacusai.prediction_dataset` +===================================== .. py:module:: abacusai.prediction_dataset -Classes -------- - -.. autoapisummary:: - - abacusai.prediction_dataset.AbstractApiClass - abacusai.prediction_dataset.PredictionDataset - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.prediction_dataset.PredictionDataset - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PredictionDataset(client, datasetId=None, datasetType=None, datasetVersion=None, default=None, required=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Batch Input Datasets @@ -47,13 +37,11 @@ Module Contents :param required: If true, this dataset is required for the batch prediction :type required: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/prediction_feature_group/index.rst.txt b/docs/_sources/autoapi/abacusai/prediction_feature_group/index.rst.txt index 9dfbb06a4..948405cde 100644 --- a/docs/_sources/autoapi/abacusai/prediction_feature_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/prediction_feature_group/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.prediction_feature_group -================================= +:py:mod:`abacusai.prediction_feature_group` +=========================================== .. py:module:: abacusai.prediction_feature_group -Classes -------- - -.. autoapisummary:: - - abacusai.prediction_feature_group.AbstractApiClass - abacusai.prediction_feature_group.PredictionFeatureGroup - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.prediction_feature_group.PredictionFeatureGroup - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PredictionFeatureGroup(client, featureGroupId=None, featureGroupVersion=None, datasetType=None, default=None, required=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Batch Input Feature Group @@ -47,13 +37,11 @@ Module Contents :param required: If true, this feature group is required for the batch prediction :type required: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/prediction_input/index.rst.txt b/docs/_sources/autoapi/abacusai/prediction_input/index.rst.txt index b8b67ab90..81b585ea1 100644 --- a/docs/_sources/autoapi/abacusai/prediction_input/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/prediction_input/index.rst.txt @@ -1,110 +1,26 @@ -abacusai.prediction_input -========================= +:py:mod:`abacusai.prediction_input` +=================================== .. py:module:: abacusai.prediction_input -Classes -------- - -.. autoapisummary:: - - abacusai.prediction_input.PredictionDataset - abacusai.prediction_input.PredictionFeatureGroup - abacusai.prediction_input.AbstractApiClass - abacusai.prediction_input.PredictionInput - - Module Contents --------------- -.. py:class:: PredictionDataset(client, datasetId=None, datasetType=None, datasetVersion=None, default=None, required=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch Input Datasets - - :param client: An authenticated API Client instance - :type client: ApiClient - :param datasetId: The unique identifier of the dataset - :type datasetId: str - :param datasetType: dataset type - :type datasetType: str - :param datasetVersion: The unique identifier of the dataset version used for predictions - :type datasetVersion: str - :param default: If true, this dataset is the default dataset in the model - :type default: bool - :param required: If true, this dataset is required for the batch prediction - :type required: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PredictionFeatureGroup(client, featureGroupId=None, featureGroupVersion=None, datasetType=None, default=None, required=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Batch Input Feature Group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: The unique identifier of the feature group - :type featureGroupId: str - :param featureGroupVersion: The unique identifier of the feature group version used for predictions - :type featureGroupVersion: str - :param datasetType: dataset type - :type datasetType: str - :param default: If true, this feature group is the default feature group in the model - :type default: bool - :param required: If true, this feature group is required for the batch prediction - :type required: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.prediction_input.PredictionInput - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PredictionInput(client, featureGroupDatasetIds=None, datasetIdRemap=None, featureGroups={}, datasets={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Batch inputs @@ -119,13 +35,11 @@ Module Contents :param datasets: List of prediction datasets :type datasets: PredictionDataset - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/prediction_operator/index.rst.txt b/docs/_sources/autoapi/abacusai/prediction_operator/index.rst.txt index 616b298a2..4c0efc638 100644 --- a/docs/_sources/autoapi/abacusai/prediction_operator/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/prediction_operator/index.rst.txt @@ -1,184 +1,26 @@ -abacusai.prediction_operator -============================ +:py:mod:`abacusai.prediction_operator` +====================================== .. py:module:: abacusai.prediction_operator -Classes -------- - -.. autoapisummary:: - - abacusai.prediction_operator.CodeSource - abacusai.prediction_operator.PredictionOperatorVersion - abacusai.prediction_operator.RefreshSchedule - abacusai.prediction_operator.AbstractApiClass - abacusai.prediction_operator.PredictionOperator - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: PredictionOperatorVersion(client, predictionOperatorId=None, predictionOperatorVersion=None, createdAt=None, updatedAt=None, sourceCode=None, memory=None, useGpu=None, featureGroupIds=None, featureGroupVersions=None, status=None, error=None, codeSource={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A prediction operator version. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param predictionOperatorId: The unique identifier of the prediction operator. - :type predictionOperatorId: str - :param predictionOperatorVersion: The unique identifier of the prediction operator version. - :type predictionOperatorVersion: str - :param createdAt: Date and time at which the prediction operator was created. - :type createdAt: str - :param updatedAt: Date and time at which the prediction operator was updated. - :type updatedAt: str - :param sourceCode: Python code used to make the prediction operator. - :type sourceCode: str - :param memory: Memory in GB specified for the prediction operator version. - :type memory: int - :param useGpu: Whether this prediction operator version is using gpu. - :type useGpu: bool - :param featureGroupIds: A list of Feature Group IDs used for initializing. - :type featureGroupIds: list - :param featureGroupVersions: A list of Feature Group version IDs used for initializing. - :type featureGroupVersions: list - :param status: The current status of the prediction operator version. - :type status: str - :param error: The error message if the status failed. - :type error: str - :param codeSource: If a python model, information on the source code. - :type codeSource: CodeSource - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete a prediction operator version. - - :param prediction_operator_version: The unique ID of the prediction operator version. - :type prediction_operator_version: str - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.prediction_operator.PredictionOperator - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PredictionOperator(client, name=None, predictionOperatorId=None, createdAt=None, updatedAt=None, projectId=None, predictFunctionName=None, sourceCode=None, initializeFunctionName=None, notebookId=None, memory=None, useGpu=None, featureGroupIds=None, featureGroupTableNames=None, codeSource={}, refreshSchedules={}, latestPredictionOperatorVersion={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A prediction operator. @@ -217,13 +59,11 @@ Module Contents :param refreshSchedules: List of refresh schedules that indicate when the next prediction operator version will be processed :type refreshSchedules: RefreshSchedule - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -232,7 +72,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -241,7 +80,6 @@ Module Contents :rtype: PredictionOperator - .. py:method:: describe() Describe an existing prediction operator. @@ -253,7 +91,6 @@ Module Contents :rtype: PredictionOperator - .. py:method:: update(name = None, feature_group_ids = None, source_code = None, initialize_function_name = None, predict_function_name = None, cpu_size = None, memory = None, package_requirements = None, use_gpu = None) Update an existing prediction operator. @@ -281,7 +118,6 @@ Module Contents :rtype: PredictionOperator - .. py:method:: delete() Delete an existing prediction operator. @@ -290,7 +126,6 @@ Module Contents :type prediction_operator_id: str - .. py:method:: deploy(auto_deploy = True) Deploy the prediction operator. @@ -302,7 +137,6 @@ Module Contents :rtype: Deployment - .. py:method:: create_version() Create a new version of the prediction operator. @@ -314,7 +148,6 @@ Module Contents :rtype: PredictionOperatorVersion - .. py:method:: list_versions() List all the prediction operator versions for a prediction operator. diff --git a/docs/_sources/autoapi/abacusai/prediction_operator_version/index.rst.txt b/docs/_sources/autoapi/abacusai/prediction_operator_version/index.rst.txt index fa8a100f9..6f0f9cb0d 100644 --- a/docs/_sources/autoapi/abacusai/prediction_operator_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/prediction_operator_version/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.prediction_operator_version -==================================== +:py:mod:`abacusai.prediction_operator_version` +============================================== .. py:module:: abacusai.prediction_operator_version -Classes -------- - -.. autoapisummary:: - - abacusai.prediction_operator_version.CodeSource - abacusai.prediction_operator_version.AbstractApiClass - abacusai.prediction_operator_version.PredictionOperatorVersion - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.prediction_operator_version.PredictionOperatorVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PredictionOperatorVersion(client, predictionOperatorId=None, predictionOperatorVersion=None, createdAt=None, updatedAt=None, sourceCode=None, memory=None, useGpu=None, featureGroupIds=None, featureGroupVersions=None, status=None, error=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A prediction operator version. @@ -112,13 +51,11 @@ Module Contents :param codeSource: If a python model, information on the source code. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -127,7 +64,6 @@ Module Contents :rtype: dict - .. py:method:: delete() Delete a prediction operator version. diff --git a/docs/_sources/autoapi/abacusai/problem_type/index.rst.txt b/docs/_sources/autoapi/abacusai/problem_type/index.rst.txt index 59625ddbd..8e6b70197 100644 --- a/docs/_sources/autoapi/abacusai/problem_type/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/problem_type/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.problem_type -===================== +:py:mod:`abacusai.problem_type` +=============================== .. py:module:: abacusai.problem_type -Classes -------- - -.. autoapisummary:: - - abacusai.problem_type.AbstractApiClass - abacusai.problem_type.ProblemType - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.problem_type.ProblemType - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ProblemType(client, problemType=None, requiredFeatureGroupType=None, optionalFeatureGroupTypes=None, useCasesSupportCustomAlgorithm=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Description of a problem type which is the common underlying problem for different use cases. @@ -45,13 +35,11 @@ Module Contents :param useCasesSupportCustomAlgorithm: A list of use cases that support custom algorithms :type useCasesSupportCustomAlgorithm: list - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/project/index.rst.txt b/docs/_sources/autoapi/abacusai/project/index.rst.txt index 37e352014..b13129d4f 100644 --- a/docs/_sources/autoapi/abacusai/project/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/project/index.rst.txt @@ -1,262 +1,26 @@ -abacusai.project -================ +:py:mod:`abacusai.project` +========================== .. py:module:: abacusai.project -Classes -------- - -.. autoapisummary:: - - abacusai.project.AgentInterface - abacusai.project.AlertActionConfig - abacusai.project.AlertConditionConfig - abacusai.project.ForecastingMonitorConfig - abacusai.project.TrainingConfig - abacusai.project.VectorStoreConfig - abacusai.project.WorkflowGraph - abacusai.project.AbstractApiClass - abacusai.project.Project - - Module Contents --------------- -.. py:class:: AgentInterface - - Bases: :py:obj:`ApiEnum` - - - Generic enumeration. - - Derive from this class to define new enumerations. - - - .. py:attribute:: DEFAULT - :value: 'DEFAULT' - - - - .. py:attribute:: CHAT - :value: 'CHAT' - - - -.. py:class:: AlertActionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert action configs - - - .. py:attribute:: action_type - :type: abacusai.api_class.enums.AlertActionType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: AlertConditionConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for alert condition configs - - - .. py:attribute:: alert_type - :type: abacusai.api_class.enums.MonitorAlertType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: ForecastingMonitorConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Forecasting Monitor Configuration - - :param id_column: The name of the column that contains the unique identifier for the time series. - :type id_column: str - :param timestamp_column: The name of the column that contains the timestamp for the time series. - :type timestamp_column: str - :param target_column: The name of the column that contains the target value for the time series. - :type target_column: str - :param start_time: The start time of the time series data. - :type start_time: str - :param end_time: The end time of the time series data. - :type end_time: str - :param window_config: The windowing configuration for the time series data. - :type window_config: TimeWindowConfig - - - .. py:attribute:: id_column - :type: str - - - .. py:attribute:: timestamp_column - :type: str - - - .. py:attribute:: target_column - :type: str - - - .. py:attribute:: start_time - :type: str - - - .. py:attribute:: end_time - :type: str - - - .. py:attribute:: window_config - :type: TimeWindowConfig - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - -.. py:class:: TrainingConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for the training config options used to train the model. - - - .. py:attribute:: _upper_snake_case_keys - :type: bool - - - .. py:attribute:: _support_kwargs - :type: bool - - - .. py:attribute:: kwargs - :type: dict - - - .. py:attribute:: problem_type - :type: abacusai.api_class.enums.ProblemType - - - .. py:attribute:: algorithm - :type: str - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: VectorStoreConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - Config for indexing options of a document retriever. Default values of optional arguments are heuristically selected by the Abacus.AI platform based on the underlying data. - - :param chunk_size: The size of text chunks in the vector store. - :type chunk_size: int - :param chunk_overlap_fraction: The fraction of overlap between chunks. - :type chunk_overlap_fraction: float - :param text_encoder: Encoder used to index texts from the documents. - :type text_encoder: VectorStoreTextEncoder - :param chunk_size_factors: Chunking data with multiple sizes. The specified list of factors are used to calculate more sizes, in addition to `chunk_size`. - :type chunk_size_factors: list - :param score_multiplier_column: If provided, will use the values in this metadata column to modify the relevance score of returned chunks for all queries. - :type score_multiplier_column: str - :param prune_vectors: Transform vectors using SVD so that the average component of vectors in the corpus are removed. - :type prune_vectors: bool - - - .. py:attribute:: chunk_size - :type: int - - - .. py:attribute:: chunk_overlap_fraction - :type: float - - - .. py:attribute:: text_encoder - :type: abacusai.api_class.enums.VectorStoreTextEncoder - - - .. py:attribute:: chunk_size_factors - :type: list - - - .. py:attribute:: score_multiplier_column - :type: str - - - .. py:attribute:: prune_vectors - :type: bool - - -.. py:class:: WorkflowGraph - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An Agent workflow graph. The edges define the node invokation order. The workflow must follow linear invokation order. - - :param nodes: A list of nodes in the workflow graph. - :type nodes: List[WorkflowGraphNode] - :param edges: A list of edges in the workflow graph, where each edge is a tuple of source, target and details. - :type edges: List[WorkflowGraphEdge] - - - .. py:attribute:: nodes - :type: List[WorkflowGraphNode] - - - .. py:attribute:: edges - :type: List[WorkflowGraphEdge] - - - .. py:method:: to_dict() - - Standardizes converting an ApiClass to dictionary. - Keys of response dictionary are converted to camel case. - This also validates the fields ( type, value, etc ) received in the dictionary. - - - - .. py:method:: from_dict(graph) - :classmethod: - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.project.Project - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Project(client, projectId=None, name=None, useCase=None, problemType=None, createdAt=None, tags=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A project is a container which holds datasets, models and deployments @@ -275,13 +39,11 @@ Module Contents :param tags: List of tags associated with the project. :type tags: list[str] - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -290,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -299,7 +60,6 @@ Module Contents :rtype: Project - .. py:method:: describe() Returns a description of a project. @@ -311,7 +71,6 @@ Module Contents :rtype: Project - .. py:method:: rename(name) This method renames a project after it is created. @@ -320,7 +79,6 @@ Module Contents :type name: str - .. py:method:: delete() Delete a specified project from your organization. @@ -336,7 +94,6 @@ Module Contents :type project_id: str - .. py:method:: add_tags(tags) This method adds a tag to a project. @@ -345,7 +102,6 @@ Module Contents :type tags: list - .. py:method:: remove_tags(tags) This method removes a tag from a project. @@ -354,7 +110,6 @@ Module Contents :type tags: list - .. py:method:: set_feature_mapping(feature_group_id, feature_name, feature_mapping = None, nested_column_name = None) Set a column's feature mapping. If the column mapping is single-use and already set in another column in this feature group, this call will first remove the other column's mapping and move it to this column. @@ -372,7 +127,6 @@ Module Contents :rtype: list[Feature] - .. py:method:: validate(feature_group_ids = None) Validates that the specified project has all required feature group types for its use case and that all required feature columns are set. @@ -384,7 +138,6 @@ Module Contents :rtype: ProjectValidation - .. py:method:: infer_feature_mappings(feature_group_id) Infer the feature mappings for the feature group in the project based on the problem type. @@ -396,7 +149,6 @@ Module Contents :rtype: InferredFeatureMappings - .. py:method:: describe_feature_group(feature_group_id) Describe a feature group associated with a project @@ -408,7 +160,6 @@ Module Contents :rtype: ProjectFeatureGroup - .. py:method:: list_feature_groups(filter_feature_group_use = None, limit = 100, start_after_id = None) List all the feature groups associated with a project @@ -424,7 +175,6 @@ Module Contents :rtype: list[ProjectFeatureGroup] - .. py:method:: list_feature_group_templates(limit = 100, start_after_id = None, should_include_all_system_templates = False) List feature group templates for feature groups associated with the project. @@ -440,7 +190,6 @@ Module Contents :rtype: list[FeatureGroupTemplate] - .. py:method:: get_training_config_options(feature_group_ids = None, for_retrain = False, current_training_config = None) Retrieves the full initial description of the model training configuration options available for the specified project. The configuration options available are determined by the use case associated with the specified project. Refer to the [Use Case Documentation]({USE_CASES_URL}) for more information on use cases and use case-specific configuration options. @@ -456,7 +205,6 @@ Module Contents :rtype: list[TrainingConfigOptions] - .. py:method:: create_train_test_data_split_feature_group(training_config, feature_group_ids) Get the train and test data split without training the model. Only supported for models with custom algorithms. @@ -470,7 +218,6 @@ Module Contents :rtype: FeatureGroup - .. py:method:: train_model(name = None, training_config = None, feature_group_ids = None, refresh_schedule = None, custom_algorithms = None, custom_algorithms_only = False, custom_algorithm_configs = None, builtin_algorithms = None, cpu_size = None, memory = None, algorithm_training_configs = None) Create a new model and start its training in the given project. @@ -502,7 +249,6 @@ Module Contents :rtype: Model - .. py:method:: create_model_from_python(function_source_code, train_function_name, training_input_tables, predict_function_name = None, predict_many_function_name = None, initialize_function_name = None, name = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False, package_requirements = None, use_gpu = False, is_thread_safe = None) Initializes a new Model from user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups. @@ -543,7 +289,6 @@ Module Contents :rtype: Model - .. py:method:: list_models() Retrieves the list of models in the specified project. @@ -555,7 +300,6 @@ Module Contents :rtype: list[Model] - .. py:method:: get_custom_train_function_info(feature_group_names_for_training = None, training_data_parameter_name_override = None, training_config = None, custom_algorithm_config = None) Returns information about how to call the custom train function. @@ -573,8 +317,7 @@ Module Contents :rtype: CustomTrainFunctionInfo - - .. py:method:: create_model_monitor(prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, include_interactive_performance_analysis = False) + .. py:method:: create_model_monitor(prediction_feature_group_id, training_feature_group_id = None, name = None, refresh_schedule = None, target_value = None, target_value_bias = None, target_value_performance = None, feature_mappings = None, model_id = None, training_feature_mappings = None, feature_group_base_monitor_config = None, feature_group_comparison_monitor_config = None, exclude_interactive_performance_analysis = True, exclude_bias_analysis = None, exclude_performance_analysis = None, exclude_feature_drift_analysis = None, exclude_data_integrity_analysis = None) Runs a model monitor for the specified project. @@ -602,14 +345,21 @@ Module Contents :type feature_group_base_monitor_config: dict :param feature_group_comparison_monitor_config: Selection strategy for the feature_group 1 with the feature group version if selected. :type feature_group_comparison_monitor_config: dict - :param include_interactive_performance_analysis: Whether to include interactive performance analysis. - :type include_interactive_performance_analysis: bool + :param exclude_interactive_performance_analysis: Whether to exclude interactive performance analysis. Defaults to True if not provided. + :type exclude_interactive_performance_analysis: bool + :param exclude_bias_analysis: Whether to exclude bias analysis in the model monitor. For default value bias analysis is included. + :type exclude_bias_analysis: bool + :param exclude_performance_analysis: Whether to exclude performance analysis in the model monitor. For default value performance analysis is included. + :type exclude_performance_analysis: bool + :param exclude_feature_drift_analysis: Whether to exclude feature drift analysis in the model monitor. For default value feature drift analysis is included. + :type exclude_feature_drift_analysis: bool + :param exclude_data_integrity_analysis: Whether to exclude data integrity analysis in the model monitor. For default value data integrity analysis is included. + :type exclude_data_integrity_analysis: bool :returns: The new model monitor that was created. :rtype: ModelMonitor - .. py:method:: list_model_monitors() Retrieves the list of model monitors in the specified project. @@ -621,7 +371,6 @@ Module Contents :rtype: list[ModelMonitor] - .. py:method:: create_vision_drift_monitor(prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) Runs a vision drift monitor for the specified project. @@ -645,7 +394,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: create_nlp_drift_monitor(prediction_feature_group_id, training_feature_group_id, name, feature_mappings, training_feature_mappings, target_value_performance = None, refresh_schedule = None) Runs an NLP drift monitor for the specified project. @@ -669,7 +417,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: create_forecasting_monitor(name, prediction_feature_group_id, training_feature_group_id, training_forecast_config, prediction_forecast_config, forecast_frequency, refresh_schedule = None) Runs a forecasting monitor for the specified project. @@ -693,7 +440,6 @@ Module Contents :rtype: ModelMonitor - .. py:method:: create_eda(feature_group_id, name, refresh_schedule = None, include_collinearity = False, include_data_consistency = False, collinearity_keys = None, primary_keys = None, data_consistency_test_config = None, data_consistency_reference_config = None, feature_mappings = None, forecast_frequency = None) Run an Exploratory Data Analysis (EDA) for the specified project. @@ -725,7 +471,6 @@ Module Contents :rtype: Eda - .. py:method:: list_eda() Retrieves the list of Exploratory Data Analysis (EDA) in the specified project. @@ -737,7 +482,6 @@ Module Contents :rtype: list[Eda] - .. py:method:: list_holdout_analysis(model_id = None) List holdout analyses for a project. Optionally, filter by model. @@ -749,7 +493,6 @@ Module Contents :rtype: list[HoldoutAnalysis] - .. py:method:: create_monitor_alert(alert_name, condition_config, action_config, model_monitor_id = None, realtime_monitor_id = None) Create a monitor alert for the given conditions and monitor. We can create monitor alert either for model monitor or real-time monitor. @@ -769,7 +512,6 @@ Module Contents :rtype: MonitorAlert - .. py:method:: list_prediction_operators() List all the prediction operators inside a project. @@ -781,7 +523,6 @@ Module Contents :rtype: list[PredictionOperator] - .. py:method:: create_deployment_token(name = None) Creates a deployment token for the specified project. @@ -796,7 +537,6 @@ Module Contents :rtype: DeploymentAuthToken - .. py:method:: list_deployments() Retrieves a list of all deployments in the specified project. @@ -808,7 +548,6 @@ Module Contents :rtype: list[Deployment] - .. py:method:: list_deployment_tokens() Retrieves a list of all deployment tokens associated with the specified project. @@ -820,7 +559,6 @@ Module Contents :rtype: list[DeploymentAuthToken] - .. py:method:: list_realtime_monitors() List the real-time monitors associated with the deployment id. @@ -832,7 +570,6 @@ Module Contents :rtype: list[RealtimeMonitor] - .. py:method:: list_refresh_policies(dataset_ids = [], feature_group_id = None, model_ids = [], deployment_ids = [], batch_prediction_ids = [], model_monitor_ids = [], notebook_ids = []) List the refresh policies for the organization. If no filters are specified, all refresh policies are returned. @@ -856,7 +593,6 @@ Module Contents :rtype: list[RefreshPolicy] - .. py:method:: list_batch_predictions() Retrieves a list of batch predictions in the project. @@ -868,7 +604,6 @@ Module Contents :rtype: list[BatchPrediction] - .. py:method:: list_pipelines() Lists the pipelines for an organization or a project @@ -880,7 +615,6 @@ Module Contents :rtype: list[Pipeline] - .. py:method:: create_graph_dashboard(name, python_function_ids = None) Create a plot dashboard given selected python plots @@ -894,7 +628,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: list_graph_dashboards() Lists the graph dashboards for a project @@ -906,7 +639,6 @@ Module Contents :rtype: list[GraphDashboard] - .. py:method:: list_builtin_algorithms(feature_group_ids, training_config = None) Return list of built-in algorithms based on given input data and training config. @@ -920,7 +652,6 @@ Module Contents :rtype: list[Algorithm] - .. py:method:: create_chat_session(name = None) Creates a chat session with Data Science Co-pilot. @@ -932,7 +663,6 @@ Module Contents :rtype: ChatSession - .. py:method:: create_agent(function_source_code = None, agent_function_name = None, name = None, memory = None, package_requirements = None, description = None, enable_binary_input = False, evaluation_feature_group_id = None, agent_input_schema = None, agent_output_schema = None, workflow_graph = None, agent_interface = AgentInterface.DEFAULT) Creates a new AI agent using the given agent workflow graph definition. @@ -954,7 +684,6 @@ Module Contents :rtype: Agent - .. py:method:: list_agents() Retrieves the list of agents in the specified project. @@ -966,7 +695,6 @@ Module Contents :rtype: list[Agent] - .. py:method:: create_document_retriever(name, feature_group_id, document_retriever_config = None) Returns a document retriever that stores embeddings for document chunks in a feature group. @@ -985,7 +713,6 @@ Module Contents :rtype: DocumentRetriever - .. py:method:: list_document_retrievers(limit = 100, start_after_id = None) List all the document retrievers. @@ -999,7 +726,6 @@ Module Contents :rtype: list[DocumentRetriever] - .. py:method:: create_model_from_functions(train_function, predict_function = None, training_input_tables = None, predict_many_function = None, initialize_function = None, cpu_size = None, memory = None, training_config = None, exclusive_run = False) Creates a model using python. diff --git a/docs/_sources/autoapi/abacusai/project_config/index.rst.txt b/docs/_sources/autoapi/abacusai/project_config/index.rst.txt index 6b99f9a02..d15c43b37 100644 --- a/docs/_sources/autoapi/abacusai/project_config/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/project_config/index.rst.txt @@ -1,54 +1,26 @@ -abacusai.project_config -======================= +:py:mod:`abacusai.project_config` +================================= .. py:module:: abacusai.project_config -Classes -------- - -.. autoapisummary:: - - abacusai.project_config.ProjectFeatureGroupConfig - abacusai.project_config.AbstractApiClass - abacusai.project_config.ProjectConfig - - Module Contents --------------- -.. py:class:: ProjectFeatureGroupConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for project feature group configuration. - - - .. py:attribute:: type - :type: abacusai.api_class.enums.ProjectConfigType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.project_config.ProjectConfig - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ProjectConfig(client, type=None, config={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Project-specific config for a feature group @@ -59,13 +31,11 @@ Module Contents :param config: Project-specific config for this feature group :type config: ProjectFeatureGroupConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/project_feature_group/index.rst.txt b/docs/_sources/autoapi/abacusai/project_feature_group/index.rst.txt index fdab8d8b4..9bbf1f1b8 100644 --- a/docs/_sources/autoapi/abacusai/project_feature_group/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/project_feature_group/index.rst.txt @@ -1,2042 +1,27 @@ -abacusai.project_feature_group -============================== +:py:mod:`abacusai.project_feature_group` +======================================== .. py:module:: abacusai.project_feature_group -Classes -------- - -.. autoapisummary:: - - abacusai.project_feature_group.AnnotationConfig - abacusai.project_feature_group.CodeSource - abacusai.project_feature_group.ConcatenationConfig - abacusai.project_feature_group.Feature - abacusai.project_feature_group.FeatureGroup - abacusai.project_feature_group.FeatureGroupTemplate - abacusai.project_feature_group.FeatureGroupVersion - abacusai.project_feature_group.IndexingConfig - abacusai.project_feature_group.NaturalLanguageExplanation - abacusai.project_feature_group.PointInTimeGroup - abacusai.project_feature_group.ProjectConfig - abacusai.project_feature_group.ProjectFeatureGroupSchema - abacusai.project_feature_group.RefreshSchedule - abacusai.project_feature_group.ProjectFeatureGroup - - -Module Contents ---------------- - -.. py:class:: AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Annotation config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureAnnotationConfigs: List of feature annotation configs - :type featureAnnotationConfigs: list - :param labels: List of labels - :type labels: list - :param statusFeature: Name of the feature that contains the status of the annotation (Optional) - :type statusFeature: str - :param commentsFeatures: Features that contain comments for the annotation (Optional) - :type commentsFeatures: list - :param metadataFeature: Name of the feature that contains the metadata for the annotation (Optional) - :type metadataFeature: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: ConcatenationConfig(client, concatenatedTable=None, mergeType=None, replaceUntilTimestamp=None, skipMaterialize=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Feature Group Concatenation Config - - :param client: An authenticated API Client instance - :type client: ApiClient - :param concatenatedTable: The feature group to concatenate with the destination feature group. - :type concatenatedTable: str - :param mergeType: The type of merge to perform, either `UNION` or `INTERSECTION`. - :type mergeType: str - :param replaceUntilTimestamp: The Unix timestamp to specify the point up to which data from the source feature group will be replaced. - :type replaceUntilTimestamp: int - :param skipMaterialize: If `True`, the concatenated feature group will not be materialized. - :type skipMaterialize: bool - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: Feature(client, name=None, selectClause=None, featureMapping=None, sourceTable=None, originalName=None, usingClause=None, orderClause=None, whereClause=None, featureType=None, dataType=None, detectedFeatureType=None, detectedDataType=None, columns={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature in a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column - :type name: str - :param selectClause: The sql logic for creating this feature's data - :type selectClause: str - :param featureMapping: The Feature Mapping of the feature - :type featureMapping: str - :param sourceTable: The source table of the column - :type sourceTable: str - :param originalName: The original name of the column - :type originalName: str - :param usingClause: Nested Column Using Clause - :type usingClause: str - :param orderClause: Nested Column Ordering Clause - :type orderClause: str - :param whereClause: Nested Column Where Clause - :type whereClause: str - :param featureType: Feature Type of the Feature - :type featureType: str - :param dataType: Data Type of the Feature - :type dataType: str - :param detectedFeatureType: The detected feature type of the column - :type detectedFeatureType: str - :param detectedDataType: The detected data type of the column - :type detectedDataType: str - :param columns: Nested Features - :type columns: NestedFeature - :param pointInTimeInfo: Point in time column information - :type pointInTimeInfo: PointInTimeFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: FeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, latestFeatureGroupVersion={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A feature group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupId: Unique identifier for this feature group. - :type featureGroupId: str - :param modificationLock: If feature group is locked against a change or not. - :type modificationLock: bool - :param name: - :type name: str - :param featureGroupSourceType: The source type of the feature group - :type featureGroupSourceType: str - :param tableName: Unique table name of this feature group. - :type tableName: str - :param sql: SQL definition creating this feature group. - :type sql: str - :param datasetId: Dataset ID the feature group is sourced from. - :type datasetId: str - :param functionSourceCode: Source definition creating this feature group. - :type functionSourceCode: str - :param functionName: Function name to execute from the source code. - :type functionName: str - :param sourceTables: Source tables for this feature group. - :type sourceTables: list[str] - :param createdAt: Timestamp at which the feature group was created. - :type createdAt: str - :param description: Description of the feature group. - :type description: str - :param sqlError: Error message with this feature group. - :type sqlError: str - :param latestVersionOutdated: Is latest materialized feature group version outdated. - :type latestVersionOutdated: bool - :param referencedFeatureGroups: Feature groups this feature group is used in. - :type referencedFeatureGroups: list[str] - :param tags: Tags added to this feature group. - :type tags: list[str] - :param primaryKey: Primary index feature. - :type primaryKey: str - :param updateTimestampKey: Primary timestamp feature. - :type updateTimestampKey: str - :param lookupKeys: Additional indexed features for this feature group. - :type lookupKeys: list[str] - :param streamingEnabled: If true, the feature group can have data streamed to it. - :type streamingEnabled: bool - :param incremental: If feature group corresponds to an incremental dataset. - :type incremental: bool - :param mergeConfig: Merge configuration settings for the feature group. - :type mergeConfig: dict - :param operatorConfig: Operator configuration settings for the feature group. - :type operatorConfig: dict - :param samplingConfig: Sampling configuration for the feature group. - :type samplingConfig: dict - :param cpuSize: CPU size specified for the Python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the Python feature group. - :type memory: int - :param streamingReady: If true, the feature group is ready to receive streaming data. - :type streamingReady: bool - :param featureTags: Tags for features in this feature group - :type featureTags: dict - :param moduleName: Path to the file with the feature group function. - :type moduleName: str - :param templateBindings: Config specifying variable names and values to use when resolving a feature group template. - :type templateBindings: dict - :param featureExpression: If the dataset feature group has custom features, the SQL select expression creating those features. - :type featureExpression: str - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: dict - :param pythonFunctionName: Name of the Python function the feature group was built from. - :type pythonFunctionName: str - :param useGpu: Whether this feature group is using gpu - :type useGpu: bool - :param features: List of resolved features. - :type features: Feature - :param duplicateFeatures: List of duplicate features. - :type duplicateFeatures: Feature - :param pointInTimeGroups: List of Point In Time Groups. - :type pointInTimeGroups: PointInTimeGroup - :param annotationConfig: Annotation config for this feature - :type annotationConfig: AnnotationConfig - :param latestFeatureGroupVersion: Latest feature group version. - :type latestFeatureGroupVersion: FeatureGroupVersion - :param concatenationConfig: Feature group ID whose data will be concatenated into this feature group. - :type concatenationConfig: ConcatenationConfig - :param indexingConfig: Indexing config for the feature group for feature store - :type indexingConfig: IndexingConfig - :param codeSource: If a Python feature group, information on the source code. - :type codeSource: CodeSource - :param featureGroupTemplate: FeatureGroupTemplate to use when this feature group is attached to a template. - :type featureGroupTemplate: FeatureGroupTemplate - :param explanation: Natural language explanation of the feature group - :type explanation: NaturalLanguageExplanation - :param refreshSchedules: List of schedules that determines when the next version of the feature group will be created. - :type refreshSchedules: RefreshSchedule - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: add_to_project(project_id, feature_group_type = 'CUSTOM_TABLE') - - Adds a feature group to a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - :param feature_group_type: The feature group type of the feature group, based on the use case under which the feature group is being created. - :type feature_group_type: str - - - - .. py:method:: set_project_config(project_id, project_config = None) - - Sets a feature group's project config - - :param project_id: Unique string identifier for the project. - :type project_id: str - :param project_config: Feature group's project configuration. - :type project_config: ProjectFeatureGroupConfig - - - - .. py:method:: get_project_config(project_id) - - Gets a feature group's project config - - :param project_id: Unique string identifier for the project. - :type project_id: str - - :returns: The feature group's project configuration. - :rtype: ProjectConfig - - - - .. py:method:: remove_from_project(project_id) - - Removes a feature group from a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - - - .. py:method:: set_type(project_id, feature_group_type = 'CUSTOM_TABLE') - - Update the feature group type in a project. The feature group must already be added to the project. - - :param project_id: Unique identifier associated with the project. - :type project_id: str - :param feature_group_type: The feature group type to set the feature group as. - :type feature_group_type: str - - - - .. py:method:: describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) - - Get the latest annotation entry for a given feature group, feature, and document. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - - :returns: The latest annotation entry for the given feature group, feature, document, and/or annotation key value. - :rtype: AnnotationEntry - - - - .. py:method:: verify_and_describe_annotation(feature_name = None, doc_id = None, feature_group_row_identifier = None) - - Get the latest annotation entry for a given feature group, feature, and document along with verification information. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - - :returns: The latest annotation entry for the given feature group, feature, document, and/or annotation key value. Includes the verification information. - :rtype: AnnotationEntry - - - - .. py:method:: update_annotation_status(feature_name, status, doc_id = None, feature_group_row_identifier = None, save_metadata = False) - - Update the status of an annotation entry. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param status: The new status of the annotation. Must be one of the following: 'TODO', 'IN_PROGRESS', 'DONE'. - :type status: str - :param doc_id: The ID of the primary document the annotation is on. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type doc_id: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the feature group's primary / identifier key value. At least one of the doc_id or feature_group_row_identifier must be provided in order to identify the correct annotation. - :type feature_group_row_identifier: str - :param save_metadata: If True, save the metadata for the annotation entry. - :type save_metadata: bool - - :returns: The updated annotation entry. - :rtype: AnnotationEntry - - - - .. py:method:: get_document_to_annotate(project_id, feature_name, feature_group_row_identifier = None, get_previous = False) - - Get an available document that needs to be annotated for a annotation feature group. - - :param project_id: The ID of the project that the annotation is associated with. - :type project_id: str - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param feature_group_row_identifier: The key value of the feature group row the annotation is on (cast to string). Usually the primary key value. If provided, fetch the immediate next (or previous) available document. - :type feature_group_row_identifier: str - :param get_previous: If True, get the previous document instead of the next document. Applicable if feature_group_row_identifier is provided. - :type get_previous: bool - - :returns: The document to annotate. - :rtype: AnnotationDocument - - - - .. py:method:: get_annotations_status(feature_name = None, check_for_materialization = False) - - Get the status of the annotations for a given feature group and feature. - - :param feature_name: The name of the feature the annotation is on. - :type feature_name: str - :param check_for_materialization: If True, check if the feature group needs to be materialized before using for annotations. - :type check_for_materialization: bool - - :returns: The status of the annotations for the given feature group and feature. - :rtype: AnnotationsStatus - - - - .. py:method:: import_annotation_labels(file, annotation_type) - - Imports annotation labels from csv file. All valid values in the file will be imported as labels (including header row if present). - - :param file: The file to import. Must be a csv file. - :type file: io.TextIOBase - :param annotation_type: The type of the annotation. - :type annotation_type: str - - :returns: The annotation config for the feature group. - :rtype: AnnotationConfig - - - - .. py:method:: create_sampling(table_name, sampling_config, description = None) - - Creates a new Feature Group defined as a sample of rows from another Feature Group. - - For efficiency, sampling is approximate unless otherwise specified. (e.g. the number of rows may vary slightly from what was requested). - - - :param table_name: The unique name to be given to this sampling Feature Group. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param sampling_config: Dictionary defining the sampling method and its parameters. - :type sampling_config: SamplingConfig - :param description: A human-readable description of this Feature Group. - :type description: str - - :returns: The created Feature Group. - :rtype: FeatureGroup - - - - .. py:method:: set_sampling_config(sampling_config) - - Set a FeatureGroup’s sampling to the config values provided, so that the rows the FeatureGroup returns will be a sample of those it would otherwise have returned. - - :param sampling_config: A JSON string object specifying the sampling method and parameters specific to that sampling method. An empty sampling_config indicates no sampling. - :type sampling_config: SamplingConfig - - :returns: The updated FeatureGroup. - :rtype: FeatureGroup - - - - .. py:method:: set_merge_config(merge_config) - - Set a MergeFeatureGroup’s merge config to the values provided, so that the feature group only returns a bounded range of an incremental dataset. - - :param merge_config: JSON object string specifying the merge rule. An empty merge_config will default to only including the latest dataset version. - :type merge_config: MergeConfig - - :returns: The updated FeatureGroup. - :rtype: FeatureGroup - - - - .. py:method:: set_operator_config(operator_config) - - Set a OperatorFeatureGroup’s operator config to the values provided. - - :param operator_config: A dictionary object specifying the pre-defined operations. - :type operator_config: dict - - - - .. py:method:: set_schema(schema) - - Creates a new schema and points the feature group to the new feature group schema ID. - - :param schema: JSON string containing an array of objects with 'name' and 'dataType' properties. - :type schema: list - - - - .. py:method:: get_schema(project_id = None) - - Returns a schema for a given FeatureGroup in a project. - - :param project_id: The unique ID associated with the project. - :type project_id: str - - :returns: A list of objects for each column in the specified feature group. - :rtype: list[Feature] - - - - .. py:method:: create_feature(name, select_expression) - - Creates a new feature in a Feature Group from a SQL select statement. - - :param name: The name of the feature to add. - :type name: str - :param select_expression: SQL SELECT expression to create the feature. - :type select_expression: str - - :returns: A Feature Group object with the newly added feature. - :rtype: FeatureGroup - - - - .. py:method:: add_tag(tag) - - Adds a tag to the feature group - - :param tag: The tag to add to the feature group. - :type tag: str - - - - .. py:method:: remove_tag(tag) - - Removes a tag from the specified feature group. - - :param tag: The tag to remove from the feature group. - :type tag: str - - - - .. py:method:: add_annotatable_feature(name, annotation_type) - - Add an annotatable feature in a Feature Group - - :param name: The name of the feature to add. - :type name: str - :param annotation_type: The type of annotation to set. - :type annotation_type: str - - :returns: The feature group after the feature has been set - :rtype: FeatureGroup - - - - .. py:method:: set_feature_as_annotatable_feature(feature_name, annotation_type, feature_group_row_identifier_feature = None, doc_id_feature = None) - - Sets an existing feature as an annotatable feature (Feature that can be annotated). - - :param feature_name: The name of the feature to set as annotatable. - :type feature_name: str - :param annotation_type: The type of annotation label to add. - :type annotation_type: str - :param feature_group_row_identifier_feature: The key value of the feature group row the annotation is on (cast to string) and uniquely identifies the feature group row. At least one of the doc_id or key value must be provided so that the correct annotation can be identified. - :type feature_group_row_identifier_feature: str - :param doc_id_feature: The name of the document ID feature. - :type doc_id_feature: str - - :returns: A feature group object with the newly added annotatable feature. - :rtype: FeatureGroup - - - - .. py:method:: set_annotation_status_feature(feature_name) - - Sets a feature as the annotation status feature for a feature group. - - :param feature_name: The name of the feature to set as the annotation status feature. - :type feature_name: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: unset_feature_as_annotatable_feature(feature_name) - - Unsets a feature as annotatable - - :param feature_name: The name of the feature to unset. - :type feature_name: str - - :returns: The feature group after unsetting the feature - :rtype: FeatureGroup - - - - .. py:method:: add_annotation_label(label_name, annotation_type, label_definition = None) - - Adds an annotation label - - :param label_name: The name of the label. - :type label_name: str - :param annotation_type: The type of the annotation to set. - :type annotation_type: str - :param label_definition: the definition of the label. - :type label_definition: str - - :returns: The feature group after adding the annotation label - :rtype: FeatureGroup - - - - .. py:method:: remove_annotation_label(label_name) - - Removes an annotation label - - :param label_name: The name of the label to remove. - :type label_name: str - - :returns: The feature group after adding the annotation label - :rtype: FeatureGroup - - - - .. py:method:: add_feature_tag(feature, tag) - - Adds a tag on a feature - - :param feature: The feature to set the tag on. - :type feature: str - :param tag: The tag to set on the feature. - :type tag: str - - - - .. py:method:: remove_feature_tag(feature, tag) - - Removes a tag from a feature - - :param feature: The feature to remove the tag from. - :type feature: str - :param tag: The tag to remove. - :type tag: str - - - - .. py:method:: create_nested_feature(nested_feature_name, table_name, using_clause, where_clause = None, order_clause = None) - - Creates a new nested feature in a feature group from a SQL statement. - - :param nested_feature_name: The name of the feature. - :type nested_feature_name: str - :param table_name: The table name of the feature group to nest. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param using_clause: The SQL join column or logic to join the nested table with the parent. - :type using_clause: str - :param where_clause: A SQL WHERE statement to filter the nested rows. - :type where_clause: str - :param order_clause: A SQL clause to order the nested rows. - :type order_clause: str - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: update_nested_feature(nested_feature_name, table_name = None, using_clause = None, where_clause = None, order_clause = None, new_nested_feature_name = None) - - Updates a previously existing nested feature in a feature group. - - :param nested_feature_name: The name of the feature to be updated. - :type nested_feature_name: str - :param table_name: The name of the table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - :param using_clause: The SQL join column or logic to join the nested table with the parent. - :type using_clause: str - :param where_clause: An SQL WHERE statement to filter the nested rows. - :type where_clause: str - :param order_clause: An SQL clause to order the nested rows. - :type order_clause: str - :param new_nested_feature_name: New name for the nested feature. - :type new_nested_feature_name: str - - :returns: A feature group object with the updated nested feature. - :rtype: FeatureGroup - - - - .. py:method:: delete_nested_feature(nested_feature_name) - - Delete a nested feature. - - :param nested_feature_name: The name of the feature to be deleted. - :type nested_feature_name: str - - :returns: A feature group object without the specified nested feature. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_feature(feature_name, history_table_name, aggregation_keys, timestamp_key, historical_timestamp_key, expression, lookback_window_seconds = None, lookback_window_lag_seconds = 0, lookback_count = None, lookback_until_position = 0) - - Creates a new point in time feature in a feature group using another historical feature group, window spec, and aggregate expression. - - We use the aggregation keys and either the lookbackWindowSeconds or the lookbackCount values to perform the window aggregation for every row in the current feature group. - - If the window is specified in seconds, then all rows in the history table which match the aggregation keys and with historicalTimeFeature greater than or equal to lookbackStartCount and less than the value of the current rows timeFeature are considered. An optional lookbackWindowLagSeconds (+ve or -ve) can be used to offset the current value of the timeFeature. If this value is negative, we will look at the future rows in the history table, so care must be taken to ensure that these rows are available in the online context when we are performing a lookup on this feature group. If the window is specified in counts, then we order the historical table rows aligning by time and consider rows from the window where the rank order is greater than or equal to lookbackCount and includes the row just prior to the current one. The lag is specified in terms of positions using lookbackUntilPosition. - - - :param feature_name: The name of the feature to create. - :type feature_name: str - :param history_table_name: The table name of the history table. - :type history_table_name: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param timestamp_key: Name of feature which contains the timestamp value for the point in time feature. - :type timestamp_key: str - :param historical_timestamp_key: Name of feature which contains the historical timestamp. - :type historical_timestamp_key: str - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param lookback_window_seconds: If window is specified in terms of time, number of seconds in the past from the current time for start of the window. - :type lookback_window_seconds: float - :param lookback_window_lag_seconds: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the "future" rows in the history table. - :type lookback_window_lag_seconds: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookback_until_position: int - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_feature(feature_name, history_table_name = None, aggregation_keys = None, timestamp_key = None, historical_timestamp_key = None, expression = None, lookback_window_seconds = None, lookback_window_lag_seconds = None, lookback_count = None, lookback_until_position = None, new_feature_name = None) - - Updates an existing Point-in-Time (PiT) feature in a feature group. See `createPointInTimeFeature` for detailed semantics. - - :param feature_name: The name of the feature. - :type feature_name: str - :param history_table_name: The table name of the history table. If not specified, we use the current table to do a self join. - :type history_table_name: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param timestamp_key: Name of the feature which contains the timestamp value for the PiT feature. - :type timestamp_key: str - :param historical_timestamp_key: Name of the feature which contains the historical timestamp. - :type historical_timestamp_key: str - :param expression: SQL Aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param lookback_window_seconds: If the window is specified in terms of time, the number of seconds in the past from the current time for the start of the window. - :type lookback_window_seconds: float - :param lookback_window_lag_seconds: Optional lag to offset the closest point for the window. If it is positive, we delay the start of the window. If it is negative, we are looking at the "future" rows in the history table. - :type lookback_window_lag_seconds: float - :param lookback_count: If the window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, we delay the start of the window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookback_until_position: int - :param new_feature_name: New name for the PiT feature. - :type new_feature_name: str - - :returns: A feature group object with the newly added nested feature. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_group(group_name, window_key, aggregation_keys, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = 0, lookback_count = None, lookback_until_position = 0) - - Create a Point-in-Time Group - - :param group_name: The name of the point in time group. - :type group_name: str - :param window_key: Name of feature to use for ordering the rows on the source table. - :type window_key: str - :param aggregation_keys: List of keys to perform on the source table for the window aggregation. - :type aggregation_keys: list - :param history_table_name: The table to use for aggregating, if not provided, the source table will be used. - :type history_table_name: str - :param history_window_key: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used. - :type history_window_key: str - :param history_aggregation_keys: List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys. - :type history_aggregation_keys: list - :param lookback_window: Number of seconds in the past from the current time for the start of the window. If 0, the lookback will include all rows. - :type lookback_window: float - :param lookback_window_lag: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, "future" rows in the history table are used. - :type lookback_window_lag: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, those many "future" rows in the history table are used. - :type lookback_until_position: int - - :returns: The feature group after the point in time group has been created. - :rtype: FeatureGroup - - - - .. py:method:: generate_point_in_time_features(group_name, columns, window_functions, prefix = None) - - Generates and adds PIT features given the selected columns to aggregate over, and the operations to include. - - :param group_name: Name of the point-in-time group. - :type group_name: str - :param columns: List of columns to generate point-in-time features for. - :type columns: list - :param window_functions: List of window functions to operate on. - :type window_functions: list - :param prefix: Prefix for generated features, defaults to group name - :type prefix: str - - :returns: Feature group object with newly added point-in-time features. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_group(group_name, window_key = None, aggregation_keys = None, history_table_name = None, history_window_key = None, history_aggregation_keys = None, lookback_window = None, lookback_window_lag = None, lookback_count = None, lookback_until_position = None) - - Update Point-in-Time Group - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param window_key: Name of feature which contains the timestamp value for the point-in-time feature. - :type window_key: str - :param aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. - :type aggregation_keys: list - :param history_table_name: The table to use for aggregating, if not provided, the source table will be used. - :type history_table_name: str - :param history_window_key: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used. - :type history_window_key: str - :param history_aggregation_keys: List of keys to use for joining the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys. - :type history_aggregation_keys: list - :param lookback_window: Number of seconds in the past from the current time for the start of the window. - :type lookback_window: float - :param lookback_window_lag: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed. If it is negative, future rows in the history table are looked at. - :type lookback_window_lag: float - :param lookback_count: If window is specified in terms of count, the start position of the window (0 is the current row). - :type lookback_count: int - :param lookback_until_position: Optional lag to offset the closest point for the window. If it is positive, the start of the window is delayed by that many rows. If it is negative, those many future rows in the history table are looked at. - :type lookback_until_position: int - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: delete_point_in_time_group(group_name) - - Delete point in time group - - :param group_name: The name of the point in time group. - :type group_name: str - - :returns: The feature group after the point in time group has been deleted. - :rtype: FeatureGroup - - - - .. py:method:: create_point_in_time_group_feature(group_name, name, expression) - - Create point in time group feature - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param name: The name of the feature to add to the point-in-time group. - :type name: str - :param expression: A SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: update_point_in_time_group_feature(group_name, name, expression) - - Update a feature's SQL expression in a point in time group - - :param group_name: The name of the point-in-time group. - :type group_name: str - :param name: The name of the feature to add to the point-in-time group. - :type name: str - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - - :returns: The feature group after the update has been applied. - :rtype: FeatureGroup - - - - .. py:method:: set_feature_type(feature, feature_type, project_id = None) - - Set the type of a feature in a feature group. Specify the feature group ID, feature name, and feature type, and the method will return the new column with the changes reflected. - - :param feature: The name of the feature. - :type feature: str - :param feature_type: The machine learning type of the data in the feature. - :type feature_type: str - :param project_id: Optional unique ID associated with the project. - :type project_id: str - - :returns: The feature group after the data_type is applied. - :rtype: Schema - - - - .. py:method:: invalidate_streaming_data(invalid_before_timestamp) - - Invalidates all streaming data with timestamp before invalidBeforeTimestamp - - :param invalid_before_timestamp: Unix timestamp; any data with a timestamp before this time will be invalidated - :type invalid_before_timestamp: int - - - - .. py:method:: concatenate_data(source_feature_group_id, merge_type = 'UNION', replace_until_timestamp = None, skip_materialize = False) - - Concatenates data from one Feature Group to another. Feature Groups can be merged if their schemas are compatible, they have the special `updateTimestampKey` column, and (if set) the `primaryKey` column. The second operand in the concatenate operation will be appended to the first operand (merge target). - - :param source_feature_group_id: The Feature Group to concatenate with the destination Feature Group. - :type source_feature_group_id: str - :param merge_type: `UNION` or `INTERSECTION`. - :type merge_type: str - :param replace_until_timestamp: The UNIX timestamp to specify the point until which we will replace data from the source Feature Group. - :type replace_until_timestamp: int - :param skip_materialize: If `True`, will not materialize the concatenated Feature Group. - :type skip_materialize: bool - - - - .. py:method:: remove_concatenation_config() - - Removes the concatenation config on a destination feature group. - - :param feature_group_id: Unique identifier of the destination feature group to remove the concatenation configuration from. - :type feature_group_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroup - - - - .. py:method:: describe() - - Describe a Feature Group. - - :param feature_group_id: A unique string identifier associated with the feature group. - :type feature_group_id: str - - :returns: The feature group object. - :rtype: FeatureGroup - - - - .. py:method:: set_indexing_config(primary_key = None, update_timestamp_key = None, lookup_keys = None) - - Sets various attributes of the feature group used for primary key, deployment lookups and streaming updates. - - :param primary_key: Name of the feature which defines the primary key of the feature group. - :type primary_key: str - :param update_timestamp_key: Name of the feature which defines the update timestamp of the feature group. Used in concatenation and primary key deduplication. - :type update_timestamp_key: str - :param lookup_keys: List of feature names which can be used in the lookup API to restrict the computation to a set of dataset rows. These feature names have to correspond to underlying dataset columns. - :type lookup_keys: list - - - - .. py:method:: update(description = None) - - Modify an existing Feature Group. - - :param description: Description of the Feature Group. - :type description: str - - :returns: Updated Feature Group object. - :rtype: FeatureGroup - - - - .. py:method:: detach_from_template() - - Update a feature group to detach it from a template. - - :param feature_group_id: Unique string identifier associated with the feature group. - :type feature_group_id: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_template_bindings(template_bindings = None) - - Update the feature group template bindings for a template feature group. - - :param template_bindings: Values in these bindings override values set in the template. - :type template_bindings: list - - :returns: Updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_python_function_bindings(python_function_bindings) - - Updates an existing Feature Group's Python function bindings from a user-provided Python Function. If a list of feature groups are supplied within the Python function bindings, we will provide DataFrames (Pandas in the case of Python) with the materialized feature groups for those input feature groups as arguments to the function. - - :param python_function_bindings: List of python function arguments. - :type python_function_bindings: List - - - - .. py:method:: update_python_function(python_function_name, python_function_bindings = None, cpu_size = None, memory = None, use_gpu = None, use_original_csv_names = None) - - Updates an existing Feature Group's python function from a user provided Python Function. If a list of feature groups are supplied within the python function - - bindings, we will provide as arguments to the function DataFrame's (pandas in the case of Python) with the materialized - feature groups for those input feature groups. - - - :param python_function_name: The name of the python function to be associated with the feature group. - :type python_function_name: str - :param python_function_bindings: List of python function arguments. - :type python_function_bindings: List - :param cpu_size: Size of the CPU for the feature group python function. - :type cpu_size: str - :param memory: Memory (in GB) for the feature group python function. - :type memory: int - :param use_gpu: Whether the feature group needs a gpu or not. Otherwise default to CPU. - :type use_gpu: bool - :param use_original_csv_names: If enabled, it uses the original column names for input feature groups from CSV datasets. - :type use_original_csv_names: bool - - - - .. py:method:: update_sql_definition(sql) - - Updates the SQL statement for a feature group. - - :param sql: The input SQL statement for the feature group. - :type sql: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_dataset_feature_expression(feature_expression) - - Updates the SQL feature expression for a Dataset FeatureGroup's custom features - - :param feature_expression: The input SQL statement for the feature group. - :type feature_expression: str - - :returns: The updated feature group. - :rtype: FeatureGroup - - - - .. py:method:: update_feature(name, select_expression = None, new_name = None) - - Modifies an existing feature in a feature group. - - :param name: Name of the feature to be updated. - :type name: str - :param select_expression: SQL statement for modifying the feature. - :type select_expression: str - :param new_name: New name of the feature. - :type new_name: str - - :returns: Updated feature group object. - :rtype: FeatureGroup - - - - .. py:method:: list_exports() - - Lists all of the feature group exports for the feature group - - :param feature_group_id: Unique identifier of the feature group - :type feature_group_id: str - - :returns: List of feature group exports - :rtype: list[FeatureGroupExport] - - - - .. py:method:: set_modifier_lock(locked = True) - - Lock a feature group to prevent modification. - - :param locked: Whether to disable or enable feature group modification (True or False). - :type locked: bool - - - - .. py:method:: list_modifiers() - - List the users who can modify a given feature group. - - :param feature_group_id: Unique string identifier of the feature group. - :type feature_group_id: str - - :returns: Information about the modification lock status and groups/organizations added to the feature group. - :rtype: ModificationLockInfo - - - - .. py:method:: add_user_to_modifiers(email) - - Adds a user to a feature group. - - :param email: The email address of the user to be added. - :type email: str - - - - .. py:method:: add_organization_group_to_modifiers(organization_group_id) - - Add OrganizationGroup to a feature group modifiers list - - :param organization_group_id: Unique string identifier of the organization group. - :type organization_group_id: str - - - - .. py:method:: remove_user_from_modifiers(email) - - Removes a user from a specified feature group. - - :param email: The email address of the user to be removed. - :type email: str - - - - .. py:method:: remove_organization_group_from_modifiers(organization_group_id) - - Removes an OrganizationGroup from a feature group modifiers list - - :param organization_group_id: The unique ID associated with the organization group. - :type organization_group_id: str - - - - .. py:method:: delete_feature(name) - - Removes a feature from the feature group. - - :param name: Name of the feature to be deleted. - :type name: str - - :returns: Updated feature group object. - :rtype: FeatureGroup - - - - .. py:method:: delete() - - Deletes a Feature Group. - - :param feature_group_id: Unique string identifier for the feature group to be removed. - :type feature_group_id: str - - - - .. py:method:: create_version(variable_bindings = None) - - Creates a snapshot for a specified feature group. Triggers materialization of the feature group. The new version of the feature group is created after it has materialized. - - :param variable_bindings: Dictionary defining variable bindings that override parent feature group values. - :type variable_bindings: dict - - :returns: A feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: list_versions(limit = 100, start_after_version = None) - - Retrieves a list of all feature group versions for the specified feature group. - - :param limit: The maximum length of the returned versions. - :type limit: int - :param start_after_version: Results will start after this version. - :type start_after_version: str - - :returns: A list of feature group versions. - :rtype: list[FeatureGroupVersion] - - - - .. py:method:: create_template(name, template_sql, template_variables, description = None, template_bindings = None, should_attach_feature_group_to_template = False) - - Create a feature group template. - - :param name: User-friendly name for this feature group template. - :type name: str - :param template_sql: The template SQL that will be resolved by applying values from the template variables to generate SQL for a feature group. - :type template_sql: str - :param template_variables: The template variables for resolving the template. - :type template_variables: list - :param description: Description of this feature group template. - :type description: str - :param template_bindings: If the feature group will be attached to the newly created template, set these variable bindings on that feature group. - :type template_bindings: list - :param should_attach_feature_group_to_template: Set to `True` to convert the feature group to a template feature group and attach it to the newly created template. - :type should_attach_feature_group_to_template: bool - - :returns: The created feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: suggest_template_for() - - Suggest values for a feature gruop template, based on a feature group. - - :param feature_group_id: Unique identifier associated with the feature group to use for suggesting values to use in the template. - :type feature_group_id: str - - :returns: The suggested feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: get_recent_streamed_data() - - Returns recently streamed data to a streaming feature group. - - :param feature_group_id: Unique string identifier associated with the feature group. - :type feature_group_id: str - - - - .. py:method:: append_data(streaming_token, data) - - Appends new data into the feature group for a given lookup key recordId. - - :param streaming_token: The streaming token for authenticating requests. - :type streaming_token: str - :param data: The data to record as a JSON object. - :type data: dict - - - - .. py:method:: append_multiple_data(streaming_token, data) - - Appends new data into the feature group for a given lookup key recordId. - - :param streaming_token: Streaming token for authenticating requests. - :type streaming_token: str - :param data: Data to record, as a list of JSON objects. - :type data: list - - - - .. py:method:: upsert_data(data, streaming_token = None) - - Update new data into the feature group for a given lookup key record ID if the record ID is found; otherwise, insert new data into the feature group. - - :param data: The data to record, in JSON format. - :type data: dict - :param streaming_token: Optional streaming token for authenticating requests if upserting to streaming FG. - :type streaming_token: str - - :returns: The feature group row that was upserted. - :rtype: FeatureGroupRow - - - - .. py:method:: delete_data(primary_key) - - Deletes a row from the feature group given the primary key - - :param primary_key: The primary key value for which to delete the feature group row - :type primary_key: str - - - - .. py:method:: get_data(primary_key = None, num_rows = None) - - Gets the feature group rows for online updatable feature groups. - - If primary key is set, row corresponding to primary_key is returned. - If num_rows is set, we return maximum of num_rows latest updated rows. - - - :param primary_key: The primary key value for which to find the feature group row - :type primary_key: str - :param num_rows: Maximum number of rows to return from the feature group - :type num_rows: int - - :returns: A list of feature group rows. - :rtype: list[FeatureGroupRow] - - - - .. py:method:: get_natural_language_explanation(feature_group_version = None, model_id = None) - - Returns the saved natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model - - :param feature_group_version: A unique string identifier associated with the Feature Group Version. - :type feature_group_version: str - :param model_id: A unique string identifier associated with the Model. - :type model_id: str - - :returns: The object containing natural language explanation(s) as field(s). - :rtype: NaturalLanguageExplanation - - - - .. py:method:: generate_natural_language_explanation(feature_group_version = None, model_id = None) - - Generates natural language explanation of an artifact with given ID. The artifact can be - Feature Group or Feature Group Version or Model - - :param feature_group_version: A unique string identifier associated with the Feature Group Version. - :type feature_group_version: str - :param model_id: A unique string identifier associated with the Model. - :type model_id: str - - :returns: The object containing natural language explanation(s) as field(s). - :rtype: NaturalLanguageExplanation - - - - .. py:method:: wait_for_dataset(timeout = 7200) - - A waiting call until the feature group's dataset, if any, is ready for use. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_upload(timeout = 7200) - - Waits for a feature group created from a dataframe to be ready for materialization and version creation. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout = 7200) - - A waiting call until feature group is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 7200 seconds. - :type timeout: int - - - - .. py:method:: wait_for_streaming_ready(timeout = 600) - - Waits for the feature group indexing config to be applied for streaming - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. Default value given is 600 seconds. - :type timeout: int - - - - .. py:method:: get_status(streaming_status = False) - - Gets the status of the feature group. - - :returns: A string describing the status of a feature group (pending, complete, etc.). - :rtype: str - - - - .. py:method:: load_as_pandas() - - Loads the feature groups into a python pandas dataframe. - - :returns: A pandas dataframe with annotations and text_snippet columns. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - - .. py:method:: describe_dataset() - - Displays the dataset attached to a feature group. - - :returns: A dataset object with all the relevant information about the dataset. - :rtype: Dataset - - - - .. py:method:: materialize() - - Materializes the feature group's latest change at the api call time. It'll skip materialization if no change since the current latest version. - - :returns: A feature group object with the lastest changes materialized. - :rtype: FeatureGroup - - - -.. py:class:: FeatureGroupTemplate(client, featureGroupTemplateId=None, description=None, featureGroupId=None, isSystemTemplate=None, name=None, templateSql=None, templateVariables=None, createdAt=None, updatedAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A template for creating feature groups. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupTemplateId: The unique identifier for this feature group template. - :type featureGroupTemplateId: str - :param description: A user-friendly text description of this feature group template. - :type description: str - :param featureGroupId: The unique identifier for the feature group used to create this template. - :type featureGroupId: str - :param isSystemTemplate: True if this is a system template returned from a user organization. - :type isSystemTemplate: bool - :param name: The user-friendly name of this feature group template. - :type name: str - :param templateSql: SQL that can include variables which will be replaced by values from the template config to resolve this template SQL into a valid SQL query for a feature group. - :type templateSql: str - :param templateVariables: A map, from template variable names to parameters for replacing those template variables with values (e.g. to values and metadata on how to resolve those values). - :type templateVariables: dict - :param createdAt: When the feature group template was created. - :type createdAt: str - :param updatedAt: When the feature group template was updated. - :type updatedAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete an existing feature group template. - - :param feature_group_template_id: Unique string identifier associated with the feature group template. - :type feature_group_template_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupTemplate - - - - .. py:method:: describe() - - Describe a Feature Group Template. - - :param feature_group_template_id: The unique identifier of a feature group template. - :type feature_group_template_id: str - - :returns: The feature group template object. - :rtype: FeatureGroupTemplate - - - - .. py:method:: update(template_sql = None, template_variables = None, description = None, name = None) - - Update a feature group template. - - :param template_sql: If provided, the new value to use for the template SQL. - :type template_sql: str - :param template_variables: If provided, the new value to use for the template variables. - :type template_variables: list - :param description: Description of this feature group template. - :type description: str - :param name: User-friendly name for this feature group template. - :type name: str - - :returns: The updated feature group template. - :rtype: FeatureGroupTemplate - - - - .. py:method:: preview_resolution(template_bindings = None, template_sql = None, template_variables = None, should_validate = True) - - Resolve template sql using template variables and template bindings. - - :param template_bindings: Values to override the template variable values specified by the template. - :type template_bindings: list - :param template_sql: If specified, use this as the template SQL instead of the feature group template's SQL. - :type template_sql: str - :param template_variables: Template variables to use. If a template is provided, this overrides the template's template variables. - :type template_variables: list - :param should_validate: If true, validates the resolved SQL. - :type should_validate: bool - - :returns: The resolved template - :rtype: ResolvedFeatureGroupTemplate - - - -.. py:class:: FeatureGroupVersion(client, featureGroupVersion=None, featureGroupId=None, sql=None, sourceTables=None, sourceDatasetVersions=None, createdAt=None, status=None, error=None, deployable=None, cpuSize=None, memory=None, useOriginalCsvNames=None, pythonFunctionBindings=None, indexingConfigWarningMsg=None, materializationStartedAt=None, materializationCompletedAt=None, columns=None, templateBindings=None, features={}, pointInTimeGroups={}, codeSource={}, annotationConfig={}, indexingConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A materialized version of a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param featureGroupVersion: The unique identifier for this materialized version of feature group. - :type featureGroupVersion: str - :param featureGroupId: The unique identifier of the feature group this version belongs to. - :type featureGroupId: str - :param sql: The sql definition creating this feature group. - :type sql: str - :param sourceTables: The source tables for this feature group. - :type sourceTables: list[str] - :param sourceDatasetVersions: The dataset version ids for this feature group version. - :type sourceDatasetVersions: list[str] - :param createdAt: The timestamp at which the feature group version was created. - :type createdAt: str - :param status: The current status of the feature group version. - :type status: str - :param error: Relevant error if the status is FAILED. - :type error: str - :param deployable: whether feature group is deployable or not. - :type deployable: bool - :param cpuSize: Cpu size specified for the python feature group. - :type cpuSize: str - :param memory: Memory in GB specified for the python feature group. - :type memory: int - :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset. - :type useOriginalCsvNames: bool - :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group. - :type pythonFunctionBindings: list - :param indexingConfigWarningMsg: The warning message related to indexing keys. - :type indexingConfigWarningMsg: str - :param materializationStartedAt: The timestamp at which the feature group materialization started. - :type materializationStartedAt: str - :param materializationCompletedAt: The timestamp at which the feature group materialization completed. - :type materializationCompletedAt: str - :param columns: List of resolved columns. - :type columns: list[feature] - :param templateBindings: Template variable bindings used for resolving the template. - :type templateBindings: list - :param features: List of features. - :type features: Feature - :param pointInTimeGroups: List of Point In Time Groups - :type pointInTimeGroups: PointInTimeGroup - :param codeSource: If a python feature group, information on the source code - :type codeSource: CodeSource - :param annotationConfig: The annotations config for the feature group. - :type annotationConfig: AnnotationConfig - :param indexingConfig: The indexing config for the feature group. - :type indexingConfig: IndexingConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: create_snapshot_feature_group(table_name) - - Creates a Snapshot Feature Group corresponding to a specific Feature Group version. - - :param table_name: Name for the newly created Snapshot Feature Group table. Can be up to 120 characters long and can only contain alphanumeric characters and underscores. - :type table_name: str - - :returns: Feature Group corresponding to the newly created Snapshot. - :rtype: FeatureGroup - - - - .. py:method:: export_to_file_connector(location, export_file_format, overwrite = False) - - Export Feature group to File Connector. - - :param location: Cloud file location to export to. - :type location: str - :param export_file_format: Enum string specifying the file format to export to. - :type export_file_format: str - :param overwrite: If true and a file exists at this location, this process will overwrite the file. - :type overwrite: bool - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_database_connector(database_connector_id, object_name, write_mode, database_feature_mapping, id_column = None, additional_id_columns = None) - - Export Feature group to Database Connector. - - :param database_connector_id: Unique string identifier for the Database Connector to export to. - :type database_connector_id: str - :param object_name: Name of the database object to write to. - :type object_name: str - :param write_mode: Enum string indicating whether to use INSERT or UPSERT. - :type write_mode: str - :param database_feature_mapping: Key/value pair JSON object of "database connector column" -> "feature name" pairs. - :type database_feature_mapping: dict - :param id_column: Required if write_mode is UPSERT. Indicates which database column should be used as the lookup key. - :type id_column: str - :param additional_id_columns: For database connectors which support it, additional ID columns to use as a complex key for upserting. - :type additional_id_columns: list - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: export_to_console(export_file_format) - - Export Feature group to console. - - :param export_file_format: File format to export to. - :type export_file_format: str - - :returns: The FeatureGroupExport instance. - :rtype: FeatureGroupExport - - - - .. py:method:: get_materialization_logs(stdout = False, stderr = False) - - Returns logs for a materialized feature group version. - - :param stdout: Set to True to get info logs. - :type stdout: bool - :param stderr: Set to True to get error logs. - :type stderr: bool - - :returns: A function logs object. - :rtype: FunctionLogs - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: FeatureGroupVersion - - - - .. py:method:: describe() - - Describe a feature group version. - - :param feature_group_version: The unique identifier associated with the feature group version. - :type feature_group_version: str - - :returns: The feature group version. - :rtype: FeatureGroupVersion - - - - .. py:method:: get_metrics(selected_columns = None, include_charts = False, include_statistics = True) - - Get metrics for a specific feature group version. - - :param selected_columns: A list of columns to order first. - :type selected_columns: List - :param include_charts: A flag indicating whether charts should be included in the response. Default is false. - :type include_charts: bool - :param include_statistics: A flag indicating whether statistics should be included in the response. Default is true. - :type include_statistics: bool - - :returns: The metrics for the specified feature group version. - :rtype: DataMetrics - - - - .. py:method:: get_logs() - - Retrieves the feature group materialization logs. - - :param feature_group_version: The unique version ID of the feature group version. - :type feature_group_version: str - - :returns: The logs for the specified feature group version. - :rtype: FeatureGroupVersionLogs - - - - .. py:method:: wait_for_results(timeout=3600) - - A waiting call until feature group version is materialized - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: wait_for_materialization(timeout=3600) - - A waiting call until feature group version is materialized. - - :param timeout: The waiting time given to the call to finish, if it doesn't finish by the allocated time, the call is said to be timed out. - :type timeout: int - - - - .. py:method:: get_status() - - Gets the status of the feature group version. - - :returns: A string describing the status of a feature group version (pending, complete, etc.). - :rtype: str - - - - .. py:method:: _download_avro_file(file_part, tmp_dir, part_index) - - - .. py:method:: load_as_pandas(max_workers=10) - - Loads the feature group version into a pandas dataframe. - - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe displaying the data in the feature group version. - :rtype: DataFrame - - - - .. py:method:: load_as_pandas_documents(doc_id_column, document_column, max_workers=10) - - Loads a feature group with documents data into a pandas dataframe. - - :param doc_id_feature: The name of the feature / column containing the document ID. - :type doc_id_feature: str - :param document_feature: The name of the feature / column which either contains the document data itself or page infos with path to remotely stored documents. This column will be replaced with the extracted document data. - :type document_feature: str - :param max_workers: The number of threads. - :type max_workers: int - - :returns: A pandas dataframe containing the extracted document data. - :rtype: DataFrame - - - -.. py:class:: IndexingConfig(client, primaryKey=None, updateTimestampKey=None, lookupKeys=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - The indexing config for a Feature Group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param primaryKey: A single key index - :type primaryKey: str - :param updateTimestampKey: The primary timestamp feature - :type updateTimestampKey: str - :param lookupKeys: A multi-key index. Cannot be used in conjuction with primary key. - :type lookupKeys: list[str] - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: NaturalLanguageExplanation(client, shortExplanation=None, longExplanation=None, isOutdated=None, htmlExplanation=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Natural language explanation of an artifact/object - - :param client: An authenticated API Client instance - :type client: ApiClient - :param shortExplanation: succinct explanation of the artifact - :type shortExplanation: str - :param longExplanation: Longer and verbose explanation of the artifact - :type longExplanation: str - :param isOutdated: Flag indicating whether the explanation is outdated due to a change in the underlying artifact - :type isOutdated: bool - :param htmlExplanation: HTML formatted explanation of the artifact - :type htmlExplanation: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PointInTimeGroup(client, groupName=None, windowKey=None, aggregationKeys=None, lookbackWindow=None, lookbackWindowLag=None, lookbackCount=None, lookbackUntilPosition=None, historyTableName=None, historyWindowKey=None, historyAggregationKeys=None, features={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point in time group containing point in time features - - :param client: An authenticated API Client instance - :type client: ApiClient - :param groupName: The name of the point in time group - :type groupName: str - :param windowKey: Name of feature which contains the timestamp value for the point in time feature - :type windowKey: str - :param aggregationKeys: List of keys to use for join the historical table and performing the window aggregation. - :type aggregationKeys: list - :param lookbackWindow: Number of seconds in the past from the current time for start of the window. - :type lookbackWindow: float - :param lookbackWindowLag: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the "future" rows in the history table. - :type lookbackWindowLag: float - :param lookbackCount: If window is specified in terms of count, the start position of the window (0 is the current row) - :type lookbackCount: int - :param lookbackUntilPosition: Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many "future" rows in the history table. - :type lookbackUntilPosition: int - :param historyTableName: The table to use for aggregating, if not provided, the source table will be used - :type historyTableName: str - :param historyWindowKey: Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used - :type historyWindowKey: str - :param historyAggregationKeys: List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table's aggregationKeys - :type historyAggregationKeys: list - :param features: List of features in the Point in Time group - :type features: PointInTimeGroupFeature - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ProjectConfig(client, type=None, config={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Project-specific config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: Type of project config - :type type: str - :param config: Project-specific config for this feature group - :type config: ProjectFeatureGroupConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: ProjectFeatureGroupSchema(client, nestedSchema=None, schema={}, duplicateFeatures={}, projectConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a project feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param nestedSchema: List of schema of nested features - :type nestedSchema: list - :param schema: List of schema description for the feature - :type schema: Schema - :param duplicateFeatures: List of duplicate featureschemas - :type duplicateFeatures: Schema - :param projectConfig: Project-specific config for this feature group. - :type projectConfig: ProjectConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A refresh schedule for an object. Defines when the next version of the object will be created - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier of the refresh policy - :type refreshPolicyId: str - :param nextRunTime: The next run time of the refresh policy. If null, the policy is paused. - :type nextRunTime: str - :param cron: A cron-style string that describes the when this refresh policy is to be executed in UTC - :type cron: str - :param refreshType: The type of refresh that will be run - :type refreshType: str - :param error: An error message for the last pipeline run of a policy - :type error: str - - - .. py:method:: __repr__() - - Return repr(self). +Module Contents +--------------- +Classes +~~~~~~~ +.. autoapisummary:: - .. py:method:: to_dict() + abacusai.project_feature_group.ProjectFeatureGroup - Get a dict representation of the parameters in this class - :returns: The dict value representation of the class parameters - :rtype: dict +.. py:class:: ProjectFeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, featureGroupType=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, projectFeatureGroupSchema={}, projectConfig={}, latestFeatureGroupVersion={}, operatorConfig={}) -.. py:class:: ProjectFeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, operatorConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, featureGroupType=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, projectFeatureGroupSchema={}, projectConfig={}, latestFeatureGroupVersion={}) Bases: :py:obj:`abacusai.feature_group.FeatureGroup` - A feature group along with project specific mappings :param client: An authenticated API Client instance @@ -2085,8 +70,6 @@ Module Contents :type incremental: bool :param mergeConfig: Merge configuration settings for the feature group. :type mergeConfig: dict - :param operatorConfig: Operator configuration settings for the feature group. - :type operatorConfig: dict :param samplingConfig: Sampling configuration for the feature group. :type samplingConfig: dict :param cpuSize: CPU size specified for the Python feature group. @@ -2139,14 +122,14 @@ Module Contents :type projectFeatureGroupSchema: ProjectFeatureGroupSchema :param projectConfig: Project-specific config for this feature group. :type projectConfig: ProjectConfig - + :param operatorConfig: Operator configuration settings for the feature group. + :type operatorConfig: OperatorConfig .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/project_feature_group_schema/index.rst.txt b/docs/_sources/autoapi/abacusai/project_feature_group_schema/index.rst.txt index e51ed8a93..dcc76c05b 100644 --- a/docs/_sources/autoapi/abacusai/project_feature_group_schema/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/project_feature_group_schema/index.rst.txt @@ -1,112 +1,26 @@ -abacusai.project_feature_group_schema -===================================== +:py:mod:`abacusai.project_feature_group_schema` +=============================================== .. py:module:: abacusai.project_feature_group_schema -Classes -------- - -.. autoapisummary:: - - abacusai.project_feature_group_schema.ProjectConfig - abacusai.project_feature_group_schema.AbstractApiClass - abacusai.project_feature_group_schema.Schema - abacusai.project_feature_group_schema.ProjectFeatureGroupSchema - - Module Contents --------------- -.. py:class:: ProjectConfig(client, type=None, config={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Project-specific config for a feature group - - :param client: An authenticated API Client instance - :type client: ApiClient - :param type: Type of project config - :type type: str - :param config: Project-specific config for this feature group - :type config: ProjectFeatureGroupConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: _get_attribute_as_dict(attribute) - - -.. py:class:: Schema(client, name=None, featureMapping=None, detectedFeatureMapping=None, featureType=None, detectedFeatureType=None, dataType=None, detectedDataType=None, nestedFeatures={}, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the feature. - :type name: str - :param featureMapping: The mapping of the feature. The possible values will be based on the project's use-case. See the (Use Case Documentation)[https://api.abacus.ai/app/help/useCases] for more details. - :type featureMapping: str - :param detectedFeatureMapping: Detected feature mapping for this feature - :type detectedFeatureMapping: str - :param featureType: The underlying data type of each feature: CATEGORICAL, CATEGORICAL_LIST, NUMERICAL, TIMESTAMP, TEXT, EMAIL, LABEL_LIST, ENTITY_LABEL_LIST, PAGE_LABEL_LIST, JSON, OBJECT_REFERENCE, MULTICATEGORICAL_LIST, COORDINATE_LIST, NUMERICAL_LIST, TIMESTAMP_LIST, ZIPCODE, URL, PAGE_INFOS, PAGES_DOCUMENT, TOKENS_DOCUMENT. - :type featureType: str - :param detectedFeatureType: The detected feature type for this feature - :type detectedFeatureType: str - :param dataType: The underlying data type of each feature: INTEGER, FLOAT, STRING, DATE, DATETIME, BOOLEAN, LIST, STRUCT, NULL, BINARY. - :type dataType: str - :param detectedDataType: The detected data type for this feature - :type detectedDataType: str - :param nestedFeatures: List of features of nested feature - :type nestedFeatures: NestedFeatureSchema - :param pointInTimeInfo: Point in time information for this feature - :type pointInTimeInfo: PointInTimeFeatureInfo - - - .. py:method:: __repr__() - - Return repr(self). - - +Classes +~~~~~~~ - .. py:method:: to_dict() +.. autoapisummary:: - Get a dict representation of the parameters in this class + abacusai.project_feature_group_schema.ProjectFeatureGroupSchema - :returns: The dict value representation of the class parameters - :rtype: dict .. py:class:: ProjectFeatureGroupSchema(client, nestedSchema=None, schema={}, duplicateFeatures={}, projectConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A schema description for a project feature group @@ -121,13 +35,11 @@ Module Contents :param projectConfig: Project-specific config for this feature group. :type projectConfig: ProjectConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/project_feature_group_schema_version/index.rst.txt b/docs/_sources/autoapi/abacusai/project_feature_group_schema_version/index.rst.txt index 04a40e9f6..6e8ab4d63 100644 --- a/docs/_sources/autoapi/abacusai/project_feature_group_schema_version/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/project_feature_group_schema_version/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.project_feature_group_schema_version -============================================= +:py:mod:`abacusai.project_feature_group_schema_version` +======================================================= .. py:module:: abacusai.project_feature_group_schema_version -Classes -------- - -.. autoapisummary:: - - abacusai.project_feature_group_schema_version.AbstractApiClass - abacusai.project_feature_group_schema_version.ProjectFeatureGroupSchemaVersion - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.project_feature_group_schema_version.ProjectFeatureGroupSchemaVersion - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ProjectFeatureGroupSchemaVersion(client, schemaVersion=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A version of a schema @@ -39,13 +29,11 @@ Module Contents :param schemaVersion: The unique identifier of a schema version. :type schemaVersion: id - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/project_validation/index.rst.txt b/docs/_sources/autoapi/abacusai/project_validation/index.rst.txt index ffdcbb4a5..007756360 100644 --- a/docs/_sources/autoapi/abacusai/project_validation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/project_validation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.project_validation -=========================== +:py:mod:`abacusai.project_validation` +===================================== .. py:module:: abacusai.project_validation -Classes -------- - -.. autoapisummary:: - - abacusai.project_validation.AbstractApiClass - abacusai.project_validation.ProjectValidation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.project_validation.ProjectValidation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ProjectValidation(client, valid=None, datasetErrors=None, columnHints=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A validation result for a project @@ -43,13 +33,11 @@ Module Contents :param columnHints: Hints for what to set on the columns :type columnHints: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/python_function/index.rst.txt b/docs/_sources/autoapi/abacusai/python_function/index.rst.txt index 2cb023b1f..176131794 100644 --- a/docs/_sources/autoapi/abacusai/python_function/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/python_function/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.python_function -======================== +:py:mod:`abacusai.python_function` +================================== .. py:module:: abacusai.python_function -Classes -------- - -.. autoapisummary:: - - abacusai.python_function.CodeSource - abacusai.python_function.AbstractApiClass - abacusai.python_function.PythonFunction - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.python_function.PythonFunction - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PythonFunction(client, notebookId=None, name=None, createdAt=None, functionVariableMappings=None, outputVariableMappings=None, functionName=None, pythonFunctionId=None, functionType=None, packageRequirements=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Customer created python function @@ -108,13 +47,11 @@ Module Contents :param codeSource: Information about the source code of the Python function. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -123,7 +60,6 @@ Module Contents :rtype: dict - .. py:method:: add_graph_to_dashboard(graph_dashboard_id, function_variable_mappings = None, name = None) Add a python plot function to a dashboard @@ -139,7 +75,6 @@ Module Contents :rtype: GraphDashboard - .. py:method:: validate_locally(kwargs = None) Validates a Python function by running it with the given input values in an local environment. Taking Input Feature Group as either name(string) or Pandas DataFrame in kwargs. diff --git a/docs/_sources/autoapi/abacusai/python_function_validator/index.rst.txt b/docs/_sources/autoapi/abacusai/python_function_validator/index.rst.txt index 762589ea0..11025e030 100644 --- a/docs/_sources/autoapi/abacusai/python_function_validator/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/python_function_validator/index.rst.txt @@ -1,27 +1,29 @@ -abacusai.python_function_validator -================================== +:py:mod:`abacusai.python_function_validator` +============================================ .. py:module:: abacusai.python_function_validator +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: abacusai.python_function_validator._MonkeyPatch + Functions ---------- +~~~~~~~~~ .. autoapisummary:: abacusai.python_function_validator.validate_function_locally -Module Contents ---------------- .. py:function:: validate_function_locally(client, python_function_name, kwargs = None) @@ -43,22 +45,20 @@ Module Contents .. py:class:: _MonkeyPatch + Helper class to prepend to ``sys.path`` and undo monkeypatching of attributes :syspath_prepend: prepend to ``sys.path`` list of import locations :undo: undo all changes made - .. py:method:: context() :classmethod: - .. py:method:: syspath_prepend(path) Prepend ``path`` to ``sys.path`` list of import locations. - .. py:method:: undo() Undo all monkeypatching done by this object. diff --git a/docs/_sources/autoapi/abacusai/python_plot_function/index.rst.txt b/docs/_sources/autoapi/abacusai/python_plot_function/index.rst.txt index 747cf3772..9b3407a5b 100644 --- a/docs/_sources/autoapi/abacusai/python_plot_function/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/python_plot_function/index.rst.txt @@ -1,87 +1,26 @@ -abacusai.python_plot_function -============================= +:py:mod:`abacusai.python_plot_function` +======================================= .. py:module:: abacusai.python_plot_function -Classes -------- - -.. autoapisummary:: - - abacusai.python_plot_function.CodeSource - abacusai.python_plot_function.AbstractApiClass - abacusai.python_plot_function.PythonPlotFunction - - Module Contents --------------- -.. py:class:: CodeSource(client, sourceType=None, sourceCode=None, applicationConnectorId=None, applicationConnectorInfo=None, packageRequirements=None, status=None, error=None, publishingMsg=None, moduleDependencies=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - Code source for python-based custom feature groups and models - - :param client: An authenticated API Client instance - :type client: ApiClient - :param sourceType: The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR - :type sourceType: str - :param sourceCode: If the type of the source is TEXT, the raw text of the function - :type sourceCode: str - :param applicationConnectorId: The Application Connector to fetch the code from - :type applicationConnectorId: str - :param applicationConnectorInfo: Args passed to the application connector to fetch the code - :type applicationConnectorInfo: str - :param packageRequirements: The pip package dependencies required to run the code - :type packageRequirements: list - :param status: The status of the code and validations - :type status: str - :param error: If the status is failed, an error message describing what went wrong - :type error: str - :param publishingMsg: Warnings in the source code - :type publishingMsg: dict - :param moduleDependencies: The list of internal modules dependencies required to run the code - :type moduleDependencies: list - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: import_as_cell() - - Adds the source code as an unexecuted cell in the notebook. - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.python_plot_function.PythonPlotFunction - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: PythonPlotFunction(client, notebookId=None, name=None, createdAt=None, functionVariableMappings=None, functionName=None, pythonFunctionId=None, functionType=None, plotName=None, graphReferenceId=None, codeSource={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Create a Plot for a Dashboard @@ -108,13 +47,11 @@ Module Contents :param codeSource: Info about the source code of the Python function. :type codeSource: CodeSource - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/range_violation/index.rst.txt b/docs/_sources/autoapi/abacusai/range_violation/index.rst.txt index 9883de385..c9c1437d0 100644 --- a/docs/_sources/autoapi/abacusai/range_violation/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/range_violation/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.range_violation -======================== +:py:mod:`abacusai.range_violation` +================================== .. py:module:: abacusai.range_violation -Classes -------- - -.. autoapisummary:: - - abacusai.range_violation.AbstractApiClass - abacusai.range_violation.RangeViolation - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.range_violation.RangeViolation - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: RangeViolation(client, name=None, trainingMin=None, trainingMax=None, predictionMin=None, predictionMax=None, freqAboveTrainingRange=None, freqBelowTrainingRange=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Summary of important range mismatches for a numerical feature discovered by a model monitoring instance @@ -51,13 +41,11 @@ Module Contents :param freqBelowTrainingRange: Frequency of prediction rows above training maximum for the specified feature. :type freqBelowTrainingRange: float - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/realtime_monitor/index.rst.txt b/docs/_sources/autoapi/abacusai/realtime_monitor/index.rst.txt index c812ce4bc..38b79a7e5 100644 --- a/docs/_sources/autoapi/abacusai/realtime_monitor/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/realtime_monitor/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.realtime_monitor -========================= +:py:mod:`abacusai.realtime_monitor` +=================================== .. py:module:: abacusai.realtime_monitor -Classes -------- - -.. autoapisummary:: - - abacusai.realtime_monitor.AbstractApiClass - abacusai.realtime_monitor.RealtimeMonitor - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.realtime_monitor.RealtimeMonitor - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: RealtimeMonitor(client, realtimeMonitorId=None, name=None, createdAt=None, deploymentId=None, lookbackTime=None, realtimeMonitorSchedule=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A real-time monitor @@ -49,13 +39,11 @@ Module Contents :param realtimeMonitorSchedule: The drift computation schedule for the real-time monitor. :type realtimeMonitorSchedule: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -64,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: update(realtime_monitor_schedule = None, lookback_time = None) Update the real-time monitor associated with the real-time monitor id. @@ -78,7 +65,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -87,7 +73,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: describe() Get the real-time monitor associated with the real-time monitor id. @@ -99,7 +84,6 @@ Module Contents :rtype: RealtimeMonitor - .. py:method:: delete() Delete the real-time monitor associated with the real-time monitor id. diff --git a/docs/_sources/autoapi/abacusai/refresh_pipeline_run/index.rst.txt b/docs/_sources/autoapi/abacusai/refresh_pipeline_run/index.rst.txt index 2cfa81d9f..7ddd0fbe9 100644 --- a/docs/_sources/autoapi/abacusai/refresh_pipeline_run/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/refresh_pipeline_run/index.rst.txt @@ -1,184 +1,26 @@ -abacusai.refresh_pipeline_run -============================= +:py:mod:`abacusai.refresh_pipeline_run` +======================================= .. py:module:: abacusai.refresh_pipeline_run -Classes -------- - -.. autoapisummary:: - - abacusai.refresh_pipeline_run.RefreshPolicy - abacusai.refresh_pipeline_run.AbstractApiClass - abacusai.refresh_pipeline_run.RefreshPipelineRun - - Module Contents --------------- -.. py:class:: RefreshPolicy(client, refreshPolicyId=None, name=None, cron=None, nextRunTime=None, createdAt=None, refreshType=None, projectId=None, datasetIds=None, featureGroupId=None, modelIds=None, deploymentIds=None, batchPredictionIds=None, modelMonitorIds=None, notebookId=None, paused=None, predictionOperatorId=None, pipelineId=None, featureGroupExportConfig={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param refreshPolicyId: The unique identifier for the refresh policy - :type refreshPolicyId: str - :param name: The user-friendly name for the refresh policy - :type name: str - :param cron: A cron-style string that describes when this refresh policy is to be executed in UTC - :type cron: str - :param nextRunTime: The next UTC time that this refresh policy will be executed - :type nextRunTime: str - :param createdAt: The time when the refresh policy was created - :type createdAt: str - :param refreshType: The type of refresh policy to be run - :type refreshType: str - :param projectId: The unique identifier of a project that this refresh policy applies to - :type projectId: str - :param datasetIds: Comma-separated list of Dataset IDs that this refresh policy applies to - :type datasetIds: list[str] - :param featureGroupId: Feature Group ID that this refresh policy applies to - :type featureGroupId: str - :param modelIds: Comma-separated list of Model IDs that this refresh policy applies to - :type modelIds: list[str] - :param deploymentIds: Comma-separated list of Deployment IDs that this refresh policy applies to - :type deploymentIds: list[str] - :param batchPredictionIds: Comma-separated list of Batch Prediction IDs that this refresh policy applies to - :type batchPredictionIds: list[str] - :param modelMonitorIds: Comma-separated list of Model Monitor IDs that this refresh policy applies to - :type modelMonitorIds: list[str] - :param notebookId: Notebook ID that this refresh policy applies to - :type notebookId: str - :param paused: True if the refresh policy is paused - :type paused: bool - :param predictionOperatorId: Prediction Operator ID that this refresh policy applies to - :type predictionOperatorId: str - :param pipelineId: The Pipeline ID With The Cron Schedule - :type pipelineId: str - :param featureGroupExportConfig: The export configuration for the feature group. Only applicable if refresh_type is FEATUREGROUP. - :type featureGroupExportConfig: FeatureGroupRefreshExportConfig - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: delete() - - Delete a refresh policy. - - :param refresh_policy_id: Unique string identifier associated with the refresh policy to delete. - :type refresh_policy_id: str - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: RefreshPolicy - - - - .. py:method:: describe() - - Retrieve a single refresh policy - - :param refresh_policy_id: The unique ID associated with this refresh policy. - :type refresh_policy_id: str - - :returns: An object representing the refresh policy. - :rtype: RefreshPolicy - - - - .. py:method:: list_refresh_pipeline_runs() - - List the the times that the refresh policy has been run - - :param refresh_policy_id: Unique identifier associated with the refresh policy. - :type refresh_policy_id: str - - :returns: List of refresh pipeline runs for the given refresh policy ID. - :rtype: list[RefreshPipelineRun] - - - - .. py:method:: pause() - - Pauses a refresh policy - - :param refresh_policy_id: Unique identifier associated with the refresh policy to be paused. - :type refresh_policy_id: str - - - - .. py:method:: resume() - - Resumes a refresh policy - - :param refresh_policy_id: The unique ID associated with this refresh policy. - :type refresh_policy_id: str - - - - .. py:method:: run() - - Force a run of the refresh policy. - - :param refresh_policy_id: Unique string identifier associated with the refresh policy to be run. - :type refresh_policy_id: str - - - - .. py:method:: update(name = None, cron = None, feature_group_export_config = None) - - Update the name or cron string of a refresh policy - - :param name: Name of the refresh policy to be updated. - :type name: str - :param cron: Cron string describing the schedule from the refresh policy to be updated. - :type cron: str - :param feature_group_export_config: Feature group export configuration to update a feature group refresh policy. - :type feature_group_export_config: FeatureGroupExportConfig - - :returns: Updated refresh policy. - :rtype: RefreshPolicy - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.refresh_pipeline_run.RefreshPipelineRun - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: RefreshPipelineRun(client, refreshPipelineRunId=None, refreshPolicyId=None, createdAt=None, startedAt=None, completedAt=None, status=None, refreshType=None, datasetVersions=None, featureGroupVersion=None, modelVersions=None, deploymentVersions=None, batchPredictions=None, refreshPolicy={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` This keeps track of the overall status of a refresh. A refresh can span multiple resources such as the creation of new dataset versions and the training of a new model version based on them. @@ -211,13 +53,11 @@ Module Contents :param refreshPolicy: The refresh policy for this refresh policy run. :type refreshPolicy: RefreshPolicy - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -226,7 +66,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -235,7 +74,6 @@ Module Contents :rtype: RefreshPipelineRun - .. py:method:: describe() Retrieve a single refresh pipeline run @@ -247,7 +85,6 @@ Module Contents :rtype: RefreshPipelineRun - .. py:method:: wait_for_complete(timeout=None) A waiting call until refresh pipeline run has completed. @@ -256,7 +93,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the refresh pipeline run. diff --git a/docs/_sources/autoapi/abacusai/refresh_policy/index.rst.txt b/docs/_sources/autoapi/abacusai/refresh_policy/index.rst.txt index 44ab6c902..6e697f645 100644 --- a/docs/_sources/autoapi/abacusai/refresh_policy/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/refresh_policy/index.rst.txt @@ -1,99 +1,26 @@ -abacusai.refresh_policy -======================= +:py:mod:`abacusai.refresh_policy` +================================= .. py:module:: abacusai.refresh_policy -Classes -------- - -.. autoapisummary:: - - abacusai.refresh_policy.FeatureGroupExportConfig - abacusai.refresh_policy.FeatureGroupRefreshExportConfig - abacusai.refresh_policy.AbstractApiClass - abacusai.refresh_policy.RefreshPolicy - - Module Contents --------------- -.. py:class:: FeatureGroupExportConfig - - Bases: :py:obj:`abacusai.api_class.abstract.ApiClass` - - - An abstract class for feature group exports. - - - .. py:attribute:: connector_type - :type: abacusai.api_class.enums.ConnectorType - - - .. py:method:: _get_builder() - :classmethod: - - - -.. py:class:: FeatureGroupRefreshExportConfig(client, connectorType=None, location=None, exportFileFormat=None, additionalIdColumns=None, databaseFeatureMapping=None, externalConnectionId=None, idColumn=None, objectName=None, writeMode=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A Feature Group Refresh Export Config outlines the export configuration for a feature group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param connectorType: The type of connector the feature group is - :type connectorType: str - :param location: The file connector location of the feature group export - :type location: str - :param exportFileFormat: The file format of the feature group export - :type exportFileFormat: str - :param additionalIdColumns: Additional id columns to use for upsert operations - :type additionalIdColumns: list - :param databaseFeatureMapping: The mapping of feature names to database columns - :type databaseFeatureMapping: dict - :param externalConnectionId: The unique identifier of the external connection to write to - :type externalConnectionId: str - :param idColumn: The column to use as the id column for upsert operations - :type idColumn: str - :param objectName: The name of the object to write to - :type objectName: str - :param writeMode: The write mode to use for the export - :type writeMode: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.refresh_policy.RefreshPolicy - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: RefreshPolicy(client, refreshPolicyId=None, name=None, cron=None, nextRunTime=None, createdAt=None, refreshType=None, projectId=None, datasetIds=None, featureGroupId=None, modelIds=None, deploymentIds=None, batchPredictionIds=None, modelMonitorIds=None, notebookId=None, paused=None, predictionOperatorId=None, pipelineId=None, featureGroupExportConfig={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated. @@ -136,13 +63,11 @@ Module Contents :param featureGroupExportConfig: The export configuration for the feature group. Only applicable if refresh_type is FEATUREGROUP. :type featureGroupExportConfig: FeatureGroupRefreshExportConfig - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -151,7 +76,6 @@ Module Contents :rtype: dict - .. py:method:: delete() Delete a refresh policy. @@ -160,7 +84,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -169,7 +92,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: describe() Retrieve a single refresh policy @@ -181,7 +103,6 @@ Module Contents :rtype: RefreshPolicy - .. py:method:: list_refresh_pipeline_runs() List the the times that the refresh policy has been run @@ -193,7 +114,6 @@ Module Contents :rtype: list[RefreshPipelineRun] - .. py:method:: pause() Pauses a refresh policy @@ -202,7 +122,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: resume() Resumes a refresh policy @@ -211,7 +130,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: run() Force a run of the refresh policy. @@ -220,7 +138,6 @@ Module Contents :type refresh_policy_id: str - .. py:method:: update(name = None, cron = None, feature_group_export_config = None) Update the name or cron string of a refresh policy diff --git a/docs/_sources/autoapi/abacusai/refresh_schedule/index.rst.txt b/docs/_sources/autoapi/abacusai/refresh_schedule/index.rst.txt index 30b856680..9bfc96f38 100644 --- a/docs/_sources/autoapi/abacusai/refresh_schedule/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/refresh_schedule/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.refresh_schedule -========================= +:py:mod:`abacusai.refresh_schedule` +=================================== .. py:module:: abacusai.refresh_schedule -Classes -------- - -.. autoapisummary:: - - abacusai.refresh_schedule.AbstractApiClass - abacusai.refresh_schedule.RefreshSchedule - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.refresh_schedule.RefreshSchedule - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: RefreshSchedule(client, refreshPolicyId=None, nextRunTime=None, cron=None, refreshType=None, error=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A refresh schedule for an object. Defines when the next version of the object will be created @@ -47,13 +37,11 @@ Module Contents :param error: An error message for the last pipeline run of a policy :type error: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/resolved_feature_group_template/index.rst.txt b/docs/_sources/autoapi/abacusai/resolved_feature_group_template/index.rst.txt index 9dc78511e..d3099883f 100644 --- a/docs/_sources/autoapi/abacusai/resolved_feature_group_template/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/resolved_feature_group_template/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.resolved_feature_group_template -======================================== +:py:mod:`abacusai.resolved_feature_group_template` +================================================== .. py:module:: abacusai.resolved_feature_group_template -Classes -------- - -.. autoapisummary:: - - abacusai.resolved_feature_group_template.AbstractApiClass - abacusai.resolved_feature_group_template.ResolvedFeatureGroupTemplate - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.resolved_feature_group_template.ResolvedFeatureGroupTemplate - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: ResolvedFeatureGroupTemplate(client, featureGroupTemplateId=None, resolvedVariables=None, resolvedSql=None, templateSql=None, sqlError=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Final SQL from resolving a feature group template. @@ -47,13 +37,11 @@ Module Contents :param sqlError: if invalid, the sql error message :type sqlError: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/return_class/index.rst.txt b/docs/_sources/autoapi/abacusai/return_class/index.rst.txt index 429c6ba08..1354e87aa 100644 --- a/docs/_sources/autoapi/abacusai/return_class/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/return_class/index.rst.txt @@ -1,28 +1,31 @@ -abacusai.return_class -===================== +:py:mod:`abacusai.return_class` +=============================== .. py:module:: abacusai.return_class +Module Contents +--------------- + Classes -------- +~~~~~~~ .. autoapisummary:: abacusai.return_class.AbstractApiClass -Module Contents ---------------- + .. py:class:: AbstractApiClass(client, id) + .. py:method:: __eq__(other) Return self==value. - .. py:method:: _get_attribute_as_dict(attribute) + diff --git a/docs/_sources/autoapi/abacusai/schema/index.rst.txt b/docs/_sources/autoapi/abacusai/schema/index.rst.txt index 4bc63e3ff..1206e3e85 100644 --- a/docs/_sources/autoapi/abacusai/schema/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/schema/index.rst.txt @@ -1,108 +1,26 @@ -abacusai.schema -=============== +:py:mod:`abacusai.schema` +========================= .. py:module:: abacusai.schema -Classes -------- - -.. autoapisummary:: - - abacusai.schema.NestedFeatureSchema - abacusai.schema.PointInTimeFeatureInfo - abacusai.schema.AbstractApiClass - abacusai.schema.Schema - - Module Contents --------------- -.. py:class:: NestedFeatureSchema(client, name=None, featureType=None, featureMapping=None, dataType=None, detectedFeatureType=None, sourceTable=None, pointInTimeInfo={}) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A schema description for a nested feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param name: The unique name of the column - :type name: str - :param featureType: Feature Type of the Feature - :type featureType: str - :param featureMapping: The Feature Mapping of the feature - :type featureMapping: str - :param dataType: Data Type of the Feature - :type dataType: str - :param detectedFeatureType: The detected feature type for this feature - :type detectedFeatureType: str - :param sourceTable: The source table of the column - :type sourceTable: str - :param pointInTimeInfo: Point in time information for this feature - :type pointInTimeInfo: PointInTimeFeatureInfo - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: PointInTimeFeatureInfo(client, expression=None, groupName=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A point-in-time infos for a feature - - :param client: An authenticated API Client instance - :type client: ApiClient - :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value. - :type expression: str - :param groupName: The group name this point-in-time feature belongs to. - :type groupName: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.schema.Schema - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Schema(client, name=None, featureMapping=None, detectedFeatureMapping=None, featureType=None, detectedFeatureType=None, dataType=None, detectedDataType=None, nestedFeatures={}, pointInTimeInfo={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A schema description for a feature @@ -127,13 +45,11 @@ Module Contents :param pointInTimeInfo: Point in time information for this feature :type pointInTimeInfo: PointInTimeFeatureInfo - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/streaming_auth_token/index.rst.txt b/docs/_sources/autoapi/abacusai/streaming_auth_token/index.rst.txt index fece3d657..4b3cb1b18 100644 --- a/docs/_sources/autoapi/abacusai/streaming_auth_token/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/streaming_auth_token/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.streaming_auth_token -============================= +:py:mod:`abacusai.streaming_auth_token` +======================================= .. py:module:: abacusai.streaming_auth_token -Classes -------- - -.. autoapisummary:: - - abacusai.streaming_auth_token.AbstractApiClass - abacusai.streaming_auth_token.StreamingAuthToken - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.streaming_auth_token.StreamingAuthToken - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: StreamingAuthToken(client, streamingToken=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A streaming authentication token that is used to authenticate requests to append data to streaming datasets @@ -41,13 +31,11 @@ Module Contents :param createdAt: When the token was created :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/streaming_client/index.rst.txt b/docs/_sources/autoapi/abacusai/streaming_client/index.rst.txt index be3a768cf..6c5f143b0 100644 --- a/docs/_sources/autoapi/abacusai/streaming_client/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/streaming_client/index.rst.txt @@ -1,98 +1,32 @@ -abacusai.streaming_client -========================= +:py:mod:`abacusai.streaming_client` +=================================== .. py:module:: abacusai.streaming_client -Classes -------- - -.. autoapisummary:: - - abacusai.streaming_client.BaseApiClient - abacusai.streaming_client.ClientOptions - abacusai.streaming_client.StreamingClient - - Module Contents --------------- -.. py:class:: BaseApiClient(api_key = None, server = None, client_options = None, skip_version_check = False) - - Abstract Base API Client - - :param api_key: The api key to use as authentication to the server - :type api_key: str - :param server: The base server url to use to send API requets to - :type server: str - :param client_options: Optional API client configurations - :type client_options: ClientOptions - :param skip_version_check: If true, will skip checking the server's current API version on initializing the client - :type skip_version_check: bool - - - .. py:attribute:: client_version - :value: '1.3.2' - - - - .. py:method:: _get_prediction_endpoint(deployment_id, deployment_token) - - - .. py:method:: _get_proxy_endpoint(deployment_id, deployment_token) - - - .. py:method:: _get_streaming_endpoint(streaming_token, model_id = None, feature_group_id = None) - - - .. py:method:: _clean_api_objects(obj) - - - .. py:method:: _call_api(action, method, query_params=None, body=None, files=None, parse_type=None, streamable_response=False, server_override=None, timeout=None, retry_500 = False, data=None) - - - .. py:method:: _proxy_request(name, method = 'POST', query_params = None, body = None, files=None, parse_type=None, is_sync = False, streamable_response = False) - - - .. py:method:: _build_class(return_class, values) - - - .. py:method:: _request(url, method, query_params=None, headers=None, body=None, files=None, stream=False, timeout=None, retry_500 = False, data=None) - - - .. py:method:: _poll(obj, wait_states, delay = 15, timeout = 300, poll_args = {}, status_field=None) - - - .. py:method:: _validate_pandas_df(df, clean_column_names) - - - .. py:method:: _upload_from_pandas(upload, df, clean_column_names=False) - - - .. py:method:: _upload_from_spark(upload, df) +Classes +~~~~~~~ +.. autoapisummary:: -.. py:class:: ClientOptions(exception_on_404 = True, server = DEFAULT_SERVER) + abacusai.streaming_client.StreamingClient - Options for configuring the ApiClient - :param exception_on_404: If true, will raise an exception on a 404 from the server, else will return None. - :type exception_on_404: bool - :param server: The default server endpoint to use for API requests - :type server: str .. py:class:: StreamingClient(client_options = None) - Bases: :py:obj:`abacusai.client.BaseApiClient` + Bases: :py:obj:`abacusai.client.BaseApiClient` Abacus.AI Streaming API Client. Does not utilize authentication and only contains public streaming methods :param client_options: Optional API client configurations :type client_options: ClientOptions - .. py:method:: upsert_item_embeddings(streaming_token, model_id, item_id, vector, catalog_id = None) Upserts an embedding vector for an item id for a model_id. @@ -109,7 +43,6 @@ Module Contents :type catalog_id: str - .. py:method:: delete_item_embeddings(streaming_token, model_id, item_ids, catalog_id = None) Deletes KNN embeddings for a list of item IDs for a given model ID. @@ -124,7 +57,6 @@ Module Contents :type catalog_id: str - .. py:method:: upsert_multiple_item_embeddings(streaming_token, model_id, upserts, catalog_id = None) Upserts a knn embedding for multiple item ids for a model_id. @@ -139,7 +71,6 @@ Module Contents :type catalog_id: str - .. py:method:: append_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. @@ -152,7 +83,6 @@ Module Contents :type data: dict - .. py:method:: append_multiple_data(feature_group_id, streaming_token, data) Appends new data into the feature group for a given lookup key recordId. diff --git a/docs/_sources/autoapi/abacusai/streaming_connector/index.rst.txt b/docs/_sources/autoapi/abacusai/streaming_connector/index.rst.txt index f5dd8e9f5..eb765efe7 100644 --- a/docs/_sources/autoapi/abacusai/streaming_connector/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/streaming_connector/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.streaming_connector -============================ +:py:mod:`abacusai.streaming_connector` +====================================== .. py:module:: abacusai.streaming_connector -Classes -------- - -.. autoapisummary:: - - abacusai.streaming_connector.AbstractApiClass - abacusai.streaming_connector.StreamingConnector - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.streaming_connector.StreamingConnector - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: StreamingConnector(client, streamingConnectorId=None, service=None, name=None, createdAt=None, status=None, auth=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A connector to an external service @@ -49,13 +39,11 @@ Module Contents :param auth: Non-secret connection information for this connector :type auth: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -64,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: verify() Checks to see if Abacus.AI can access the streaming connector. @@ -73,7 +60,6 @@ Module Contents :type streaming_connector_id: str - .. py:method:: rename(name) Renames a Streaming Connector @@ -82,7 +68,6 @@ Module Contents :type name: str - .. py:method:: delete() Delete a streaming connector. diff --git a/docs/_sources/autoapi/abacusai/streaming_row_count/index.rst.txt b/docs/_sources/autoapi/abacusai/streaming_row_count/index.rst.txt index 6697351ac..09d36f9b1 100644 --- a/docs/_sources/autoapi/abacusai/streaming_row_count/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/streaming_row_count/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.streaming_row_count -============================ +:py:mod:`abacusai.streaming_row_count` +====================================== .. py:module:: abacusai.streaming_row_count -Classes -------- - -.. autoapisummary:: - - abacusai.streaming_row_count.AbstractApiClass - abacusai.streaming_row_count.StreamingRowCount - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.streaming_row_count.StreamingRowCount - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: StreamingRowCount(client, count=None, startTsMs=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Returns the number of rows in a streaming feature group from the specified time @@ -41,13 +31,11 @@ Module Contents :param startTsMs: The start time for the number of rows. :type startTsMs: int - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/streaming_sample_code/index.rst.txt b/docs/_sources/autoapi/abacusai/streaming_sample_code/index.rst.txt index 06ad73e9f..77d8f51db 100644 --- a/docs/_sources/autoapi/abacusai/streaming_sample_code/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/streaming_sample_code/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.streaming_sample_code -============================== +:py:mod:`abacusai.streaming_sample_code` +======================================== .. py:module:: abacusai.streaming_sample_code -Classes -------- - -.. autoapisummary:: - - abacusai.streaming_sample_code.AbstractApiClass - abacusai.streaming_sample_code.StreamingSampleCode - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.streaming_sample_code.StreamingSampleCode - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: StreamingSampleCode(client, python=None, curl=None, console=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Sample code for adding to a streaming feature group with examples from different locations. @@ -43,13 +33,11 @@ Module Contents :param console: The console code sample :type console: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/test_point_predictions/index.rst.txt b/docs/_sources/autoapi/abacusai/test_point_predictions/index.rst.txt index 93313f72b..c34267cca 100644 --- a/docs/_sources/autoapi/abacusai/test_point_predictions/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/test_point_predictions/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.test_point_predictions -=============================== +:py:mod:`abacusai.test_point_predictions` +========================================= .. py:module:: abacusai.test_point_predictions -Classes -------- - -.. autoapisummary:: - - abacusai.test_point_predictions.AbstractApiClass - abacusai.test_point_predictions.TestPointPredictions - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.test_point_predictions.TestPointPredictions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: TestPointPredictions(client, count=None, columns=None, data=None, metricsColumns=None, summarizedMetrics=None, errorDescription=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Test Point Predictions @@ -49,13 +39,11 @@ Module Contents :param errorDescription: Description of an error in case of failure. :type errorDescription: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/training_config_options/index.rst.txt b/docs/_sources/autoapi/abacusai/training_config_options/index.rst.txt index 33f9aafd4..2b4867033 100644 --- a/docs/_sources/autoapi/abacusai/training_config_options/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/training_config_options/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.training_config_options -================================ +:py:mod:`abacusai.training_config_options` +========================================== .. py:module:: abacusai.training_config_options -Classes -------- - -.. autoapisummary:: - - abacusai.training_config_options.AbstractApiClass - abacusai.training_config_options.TrainingConfigOptions - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.training_config_options.TrainingConfigOptions - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: TrainingConfigOptions(client, name=None, dataType=None, valueType=None, valueOptions=None, value=None, default=None, options=None, description=None, required=None, lastModelValue=None, needsRefresh=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Training options for a model @@ -59,13 +49,11 @@ Module Contents :param needsRefresh: True if training config needs to be fetched again when this config option is changed :type needsRefresh: bool - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/upload/index.rst.txt b/docs/_sources/autoapi/abacusai/upload/index.rst.txt index 8d8f2c6eb..6c628b04c 100644 --- a/docs/_sources/autoapi/abacusai/upload/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/upload/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.upload -=============== +:py:mod:`abacusai.upload` +========================= .. py:module:: abacusai.upload -Classes -------- - -.. autoapisummary:: - - abacusai.upload.AbstractApiClass - abacusai.upload.Upload - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.upload.Upload - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Upload(client, uploadId=None, datasetUploadId=None, status=None, datasetId=None, datasetVersion=None, modelId=None, modelVersion=None, batchPredictionId=None, parts=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Upload Reference for uploading file parts @@ -57,13 +47,11 @@ Module Contents :param createdAt: The timestamp at which the upload was created. :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -72,7 +60,6 @@ Module Contents :rtype: dict - .. py:method:: cancel() Cancels an upload. @@ -81,7 +68,6 @@ Module Contents :type upload_id: str - .. py:method:: part(part_number, part_data) Uploads part of a large dataset file from your bucket to our system. Our system currently supports parts of up to 5GB and full files of up to 5TB. Note that each part must be at least 5MB in size, unless it is the last part in the sequence of parts for the full file. @@ -95,7 +81,6 @@ Module Contents :rtype: UploadPart - .. py:method:: mark_complete() Marks an upload process as complete. @@ -107,7 +92,6 @@ Module Contents :rtype: Upload - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -116,7 +100,6 @@ Module Contents :rtype: Upload - .. py:method:: describe() Retrieves the current upload status (complete or inspecting) and the list of file parts uploaded for a specified dataset upload. @@ -128,7 +111,6 @@ Module Contents :rtype: Upload - .. py:method:: upload_part(upload_args) Uploads a file part. @@ -137,7 +119,6 @@ Module Contents :rtype: UploadPart - .. py:method:: upload_file(file, threads=10, chunksize=1024 * 1024 * 10, wait_timeout=600) Uploads the file in the specified chunk size using the specified number of workers. @@ -155,7 +136,6 @@ Module Contents :rtype: Upload - .. py:method:: _yield_upload_part(file, chunksize) @@ -167,7 +147,6 @@ Module Contents :type timeout: int - .. py:method:: get_status() Gets the status of the upload. diff --git a/docs/_sources/autoapi/abacusai/upload_part/index.rst.txt b/docs/_sources/autoapi/abacusai/upload_part/index.rst.txt index 8ca106274..3871e89bf 100644 --- a/docs/_sources/autoapi/abacusai/upload_part/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/upload_part/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.upload_part -==================== +:py:mod:`abacusai.upload_part` +============================== .. py:module:: abacusai.upload_part -Classes -------- - -.. autoapisummary:: - - abacusai.upload_part.AbstractApiClass - abacusai.upload_part.UploadPart - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.upload_part.UploadPart - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: UploadPart(client, etag=None, md5=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Unique identifiers for a part @@ -41,13 +31,11 @@ Module Contents :param md5: The MD5 hash of this part. :type md5: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/use_case/index.rst.txt b/docs/_sources/autoapi/abacusai/use_case/index.rst.txt index 400dc2072..40076c347 100644 --- a/docs/_sources/autoapi/abacusai/use_case/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/use_case/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.use_case -================= +:py:mod:`abacusai.use_case` +=========================== .. py:module:: abacusai.use_case -Classes -------- - -.. autoapisummary:: - - abacusai.use_case.AbstractApiClass - abacusai.use_case.UseCase - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.use_case.UseCase - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: UseCase(client, useCase=None, prettyName=None, description=None, problemType=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Project Use Case @@ -45,13 +35,11 @@ Module Contents :param problemType: Name for the underlying problem type :type problemType: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/use_case_requirements/index.rst.txt b/docs/_sources/autoapi/abacusai/use_case_requirements/index.rst.txt index 1bc684c6b..4ba76cd2b 100644 --- a/docs/_sources/autoapi/abacusai/use_case_requirements/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/use_case_requirements/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.use_case_requirements -============================== +:py:mod:`abacusai.use_case_requirements` +======================================== .. py:module:: abacusai.use_case_requirements -Classes -------- - -.. autoapisummary:: - - abacusai.use_case_requirements.AbstractApiClass - abacusai.use_case_requirements.UseCaseRequirements - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.use_case_requirements.UseCaseRequirements - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: UseCaseRequirements(client, datasetType=None, name=None, description=None, required=None, multi=None, allowedFeatureMappings=None, allowedNestedFeatureMappings=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Use Case Requirements @@ -51,13 +41,11 @@ Module Contents :param allowedNestedFeatureMappings: A collection of key-value pairs, with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { "description": str, "allowed_feature_types": feature_type_enum, "required": bool }. :type allowedNestedFeatureMappings: dict - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/user/index.rst.txt b/docs/_sources/autoapi/abacusai/user/index.rst.txt index aeb1532a8..c01008202 100644 --- a/docs/_sources/autoapi/abacusai/user/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/user/index.rst.txt @@ -1,150 +1,26 @@ -abacusai.user -============= +:py:mod:`abacusai.user` +======================= .. py:module:: abacusai.user -Classes -------- - -.. autoapisummary:: - - abacusai.user.OrganizationGroup - abacusai.user.AbstractApiClass - abacusai.user.User - - Module Contents --------------- -.. py:class:: OrganizationGroup(client, organizationGroupId=None, permissions=None, groupName=None, defaultGroup=None, admin=None, createdAt=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - An Organization Group. Defines the permissions available to the users who are members of the group. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param organizationGroupId: The unique identifier of the Organization Group. - :type organizationGroupId: str - :param permissions: The list of permissions (VIEW, MODIFY, ADMIN, BILLING, API_KEY, INVITE_USER) the group has. - :type permissions: list of enum string - :param groupName: The name of the Organization Group. - :type groupName: str - :param defaultGroup: If true, all new users will be added to this group automatically. - :type defaultGroup: bool - :param admin: If true, this group contains all permissions available to the organization and cannot be modified or deleted. - :type admin: bool - :param createdAt: When the Organization Group was created. - :type createdAt: str - - - .. py:method:: __repr__() - - Return repr(self). - - - - .. py:method:: to_dict() - - Get a dict representation of the parameters in this class - - :returns: The dict value representation of the class parameters - :rtype: dict - - - - .. py:method:: refresh() - - Calls describe and refreshes the current object's fields - - :returns: The current object - :rtype: OrganizationGroup - - - - .. py:method:: describe() - - Returns the specific organization group passed in by the user. - - :param organization_group_id: The unique identifier of the organization group to be described. - :type organization_group_id: str - - :returns: Information about a specific organization group. - :rtype: OrganizationGroup - - - - .. py:method:: add_permission(permission) - - Adds a permission to the specified Organization Group. - - :param permission: Permission to add to the Organization Group. - :type permission: str - - - - .. py:method:: remove_permission(permission) - - Removes a permission from the specified Organization Group. - - :param permission: The permission to remove from the Organization Group. - :type permission: str - - - - .. py:method:: delete() - - Deletes the specified Organization Group - - :param organization_group_id: Unique string identifier of the organization group. - :type organization_group_id: str - - - - .. py:method:: add_user_to(email) - - Adds a user to the specified Organization Group. - - :param email: Email of the user to be added to the group. - :type email: str - - - - .. py:method:: remove_user_from(email) - - Removes a user from an Organization Group. - - :param email: Email of the user to remove. - :type email: str - - - - .. py:method:: set_default() - - Sets the default Organization Group to which all new users joining an organization are automatically added. - - :param organization_group_id: Unique string identifier of the Organization Group. - :type organization_group_id: str - - - -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.user.User - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: User(client, name=None, email=None, createdAt=None, status=None, organizationGroups={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` An Abacus.AI User @@ -161,13 +37,11 @@ Module Contents :param organizationGroups: List of Organization Groups this user belongs to. :type organizationGroups: OrganizationGroup - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/user_exception/index.rst.txt b/docs/_sources/autoapi/abacusai/user_exception/index.rst.txt index 44cba7ef6..47e0780ab 100644 --- a/docs/_sources/autoapi/abacusai/user_exception/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/user_exception/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.user_exception -======================= +:py:mod:`abacusai.user_exception` +================================= .. py:module:: abacusai.user_exception -Classes -------- - -.. autoapisummary:: - - abacusai.user_exception.AbstractApiClass - abacusai.user_exception.UserException - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.user_exception.UserException - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: UserException(client, type=None, value=None, traceback=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Exception information for errors in usercode. @@ -43,13 +33,11 @@ Module Contents :param traceback: The traceback of the exception :type traceback: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/web_search_response/index.rst.txt b/docs/_sources/autoapi/abacusai/web_search_response/index.rst.txt index 9d2504bed..78e90dbfb 100644 --- a/docs/_sources/autoapi/abacusai/web_search_response/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/web_search_response/index.rst.txt @@ -1,71 +1,26 @@ -abacusai.web_search_response -============================ +:py:mod:`abacusai.web_search_response` +====================================== .. py:module:: abacusai.web_search_response -Classes -------- - -.. autoapisummary:: - - abacusai.web_search_response.AbstractApiClass - abacusai.web_search_response.WebSearchResult - abacusai.web_search_response.WebSearchResponse - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) - - Return self==value. - - - - .. py:method:: _get_attribute_as_dict(attribute) - - -.. py:class:: WebSearchResult(client, title=None, url=None, snippet=None, content=None) - - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` - - - A single search result. - - :param client: An authenticated API Client instance - :type client: ApiClient - :param title: The title of the search result. - :type title: str - :param url: The URL of the search result. - :type url: str - :param snippet: The snippet of the search result. - :type snippet: str - :param content: The page of content fetched from the url. - :type content: str - - - .. py:method:: __repr__() - - Return repr(self). - - +Classes +~~~~~~~ - .. py:method:: to_dict() +.. autoapisummary:: - Get a dict representation of the parameters in this class + abacusai.web_search_response.WebSearchResponse - :returns: The dict value representation of the class parameters - :rtype: dict .. py:class:: WebSearchResponse(client, searchResults={}) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` Result of running a web search with optional content fetching. @@ -74,13 +29,11 @@ Module Contents :param searchResults: List of search results. :type searchResults: WebSearchResult - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/web_search_result/index.rst.txt b/docs/_sources/autoapi/abacusai/web_search_result/index.rst.txt index 47b08ebdd..f341d4e73 100644 --- a/docs/_sources/autoapi/abacusai/web_search_result/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/web_search_result/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.web_search_result -========================== +:py:mod:`abacusai.web_search_result` +==================================== .. py:module:: abacusai.web_search_result -Classes -------- - -.. autoapisummary:: - - abacusai.web_search_result.AbstractApiClass - abacusai.web_search_result.WebSearchResult - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.web_search_result.WebSearchResult - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: WebSearchResult(client, title=None, url=None, snippet=None, content=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A single search result. @@ -45,13 +35,11 @@ Module Contents :param content: The page of content fetched from the url. :type content: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class diff --git a/docs/_sources/autoapi/abacusai/webhook/index.rst.txt b/docs/_sources/autoapi/abacusai/webhook/index.rst.txt index 49445d2aa..8f043f812 100644 --- a/docs/_sources/autoapi/abacusai/webhook/index.rst.txt +++ b/docs/_sources/autoapi/abacusai/webhook/index.rst.txt @@ -1,36 +1,26 @@ -abacusai.webhook -================ +:py:mod:`abacusai.webhook` +========================== .. py:module:: abacusai.webhook -Classes -------- - -.. autoapisummary:: - - abacusai.webhook.AbstractApiClass - abacusai.webhook.Webhook - - Module Contents --------------- -.. py:class:: AbstractApiClass(client, id) - - .. py:method:: __eq__(other) +Classes +~~~~~~~ - Return self==value. +.. autoapisummary:: + abacusai.webhook.Webhook - .. py:method:: _get_attribute_as_dict(attribute) .. py:class:: Webhook(client, webhookId=None, deploymentId=None, endpoint=None, webhookEventType=None, payloadTemplate=None, createdAt=None) - Bases: :py:obj:`abacusai.return_class.AbstractApiClass` + Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A Abacus.AI Webhook attached to an endpoint and event trigger for a given object. @@ -49,13 +39,11 @@ Module Contents :param createdAt: The date and time this webhook was created. :type createdAt: str - .. py:method:: __repr__() Return repr(self). - .. py:method:: to_dict() Get a dict representation of the parameters in this class @@ -64,7 +52,6 @@ Module Contents :rtype: dict - .. py:method:: refresh() Calls describe and refreshes the current object's fields @@ -73,7 +60,6 @@ Module Contents :rtype: Webhook - .. py:method:: describe() Describe the webhook with a given ID. @@ -85,7 +71,6 @@ Module Contents :rtype: Webhook - .. py:method:: update(endpoint = None, webhook_event_type = None, payload_template = None) Update the webhook @@ -98,7 +83,6 @@ Module Contents :type payload_template: dict - .. py:method:: delete() Delete the webhook diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 92da3f8b2..eaed90953 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -178,7 +178,7 @@ const Search = { htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlinks", "script", "style"]) { + for (const removalQuery of [".headerlink", "script", "style"]) { htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); } if (anchor) { diff --git a/docs/autoapi/abacusai/abacus_api/index.html b/docs/autoapi/abacusai/abacus_api/index.html index 0e197c3b0..d3bbd1eb5 100644 --- a/docs/autoapi/abacusai/abacus_api/index.html +++ b/docs/autoapi/abacusai/abacus_api/index.html @@ -46,222 +46,217 @@