abacusai 1.2.3__tar.gz → 1.2.4__tar.gz

{abacusai-1.2.3/abacusai.egg-info → abacusai-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: abacusai
-Version: 1.2.3
+Version: 1.2.4
 Summary: Abacus.AI Python Client Library
 Home-page: https://github.com/abacusai/api-python
 Author: Abacus.AI

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/__init__.py

@@ -4,4 +4,4 @@ from .prediction_client import PredictionClient
 from .streaming_client import StreamingClient
 
 
-__version__ = "1.2.3"
+__version__ = "1.2.4"

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/agent.py

@@ -23,6 +23,7 @@ class Agent(AbstractApiClass):
             agentExecutionConfig (dict): The config for arguments used to execute the agent.
             latestAgentVersion (AgentVersion): The latest agent version.
             codeSource (CodeSource): If a python model, information on the source code
+            workflowGraph (WorkflowGraph): The workflow graph for the agent.
     """
 
     def __init__(self, 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={}):

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/agent_data_upload_result.py

@@ -1,4 +1,3 @@
-from .agent_data_document_info import AgentDataDocumentInfo
 from .return_class import AbstractApiClass
 
 
@@ -8,12 +7,12 @@ class AgentDataUploadResult(AbstractApiClass):
 
         Args:
             client (ApiClient): An authenticated API Client instance
-            docInfos (AgentDataDocumentInfo): A list of dict for information on the documents uploaded to agent.
+            docInfos (list[agentdatadocumentinfo]): A list of dict for information on the documents uploaded to agent.
     """
 
-    def __init__(self, client, docInfos={}):
+    def __init__(self, client, docInfos=None):
         super().__init__(client, None)
-        self.doc_infos = client._build_class(AgentDataDocumentInfo, docInfos)
+        self.doc_infos = docInfos
         self.deprecated_keys = {}
 
     def __repr__(self):
@@ -30,5 +29,5 @@ class AgentDataUploadResult(AbstractApiClass):
         Returns:
             dict: The dict value representation of the class parameters
         """
-        resp = {'doc_infos': self._get_attribute_as_dict(self.doc_infos)}
+        resp = {'doc_infos': self.doc_infos}
         return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys}

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/agent_version.py

@@ -20,6 +20,7 @@ class AgentVersion(AbstractApiClass):
             error (str): Relevant error if the status is FAILED.
             agentExecutionConfig (dict): The config for arguments used to execute the agent.
             codeSource (CodeSource): If a python model, information on where the source code is located.
+            workflowGraph (WorkflowGraph): The workflow graph for the agent.
     """
 
     def __init__(self, client, agentVersion=None, status=None, agentId=None, agentConfig=None, publishingStartedAt=None, publishingCompletedAt=None, pendingDeploymentIds=None, failedDeploymentIds=None, error=None, agentExecutionConfig=None, codeSource={}, workflowGraph={}):

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/api_class/abstract.py

@@ -4,7 +4,8 @@ import inspect
 import re
 from abc import ABC
 from copy import deepcopy
-from typing import Any, get_origin, get_type_hints
+from textwrap import dedent
+from typing import Any, Callable, get_origin, get_type_hints
 
 from .enums import ApiEnum
 
@@ -34,6 +35,16 @@ def snake_case(value):
     return value
 
 
+def get_clean_function_source_code(func: Callable):
+    sample_lambda = (lambda: 0)
+    if isinstance(func, type(sample_lambda)) and func.__name__ == sample_lambda.__name__:
+        raise ValueError('Lambda function not allowed.')
+    source_code = inspect.getsource(func)
+    # If function source code has some initial indentation, remove it (Ex - can happen if the functor was defined inside a function)
+    source_code = dedent(source_code)
+    return source_code
+
+
 @dataclasses.dataclass
 class ApiClass(ABC):
     _upper_snake_case_keys: bool = dataclasses.field(default=False, repr=False, init=False)
@@ -111,12 +122,12 @@ class ApiClass(ABC):
             res = {}
             api_class_dict = vars(api_class_obj)
             if self._support_kwargs:
-                kwargs = api_class_dict.pop('kwargs', None)
+                kwargs = api_class_dict.get('kwargs', None)
                 api_class_dict.update(kwargs or {})
             for k, v in api_class_dict.items():
-                if not k.startswith('__'):
-                    k = upper_snake_case(k) if self._upper_snake_case_keys else camel_case(k)
-                if v is not None:
+                if v is not None and k != 'kwargs':
+                    if not k.startswith('__'):
+                        k = upper_snake_case(k) if self._upper_snake_case_keys else camel_case(k)
                     if isinstance(v, ApiClass):
                         res[k] = to_dict_helper(v)
                     elif isinstance(v, list):
@@ -125,11 +136,10 @@ class ApiClass(ABC):
                         res[k] = {key: to_dict_helper(val) if isinstance(val, ApiClass) else val for key, val in v.items()}
                     elif isinstance(v, datetime.datetime) or isinstance(v, datetime.date):
                         res[k] = v.isoformat() if v else v
+                    elif isinstance(v, ApiEnum):
+                        res[k] = v.value
                     else:
-                        if isinstance(v, ApiEnum):
-                            res[k] = v.value
-                        else:
-                            res[k] = v
+                        res[k] = v
             return res
 
         return to_dict_helper(self)

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/api_class/ai_agents.py

@@ -2,7 +2,7 @@ import dataclasses
 from typing import List, Union
 
 from . import enums
-from .abstract import ApiClass
+from .abstract import ApiClass, get_clean_function_source_code
 
 
 @dataclasses.dataclass
@@ -14,7 +14,7 @@ class FieldDescriptor(ApiClass):
         field (str): The field to be extracted. This will be used as the key in the response.
         description (str): The description of this field. If not included, the response_field will be used.
         example_extraction (Union[str, int, bool, float]): An example of this extracted field.
-        type (enums.FieldDescriptorType): The type of this field. If not provided, the default type is STRING.
+        type (FieldDescriptorType): The type of this field. If not provided, the default type is STRING.
     """
     field: str = dataclasses.field()
     description: str = dataclasses.field(default=None)
@@ -29,20 +29,23 @@ class WorkflowNodeInputMapping(ApiClass):
 
     Args:
         name (str): The name of the input.
-        variable_type (str): The type of the input.
-        workflow_variable_source (str): The workflow source stage of the input.
+        variable_type (WorkflowNodeInputType): The type of the input.
+        variable_source (str): The name of the node this variable is sourced from.
+                               If the type is `WORKFLOW_VARIABLE`, the value given by the source node will be directly used.
+                               If the type is `USER_INPUT`, the value given by the source node will be used as the default initial value before user edits it.
+                               Set to `None` if the type is `USER_INPUT` and the variable doesn't need a pre-filled initial value.
         is_required (bool): Whether the input is required.
     """
     name: str
     variable_type: enums.WorkflowNodeInputType
-    workflow_variable_source: str = dataclasses.field(default=None)
+    variable_source: str = dataclasses.field(default=None)
     is_required: bool = dataclasses.field(default=True)
 
     def to_dict(self):
         return {
             'name': self.name,
             'variable_type': self.variable_type,
-            'workflow_variable_source': self.workflow_variable_source,
+            'variable_source': self.variable_source,
             'is_required': self.is_required
         }
 
@@ -54,7 +57,7 @@ class WorkflowNodeOutputMapping(ApiClass):
 
     Args:
         name (str): The name of the output.
-        variable_type (str): The type of the output.
+        variable_type (WorkflowNodeOutputType): The type of the output.
     """
     name: str
     variable_type: enums.WorkflowNodeOutputType = dataclasses.field(default=enums.WorkflowNodeOutputType.STRING)
@@ -72,12 +75,10 @@ class WorkflowGraphNode(ApiClass):
     A node in an Agent workflow graph.
 
     Args:
-        name (str): Display name of the worflow node.
+        name (str): A unique name for the workflow node.
         input_mappings (List[WorkflowNodeInputMapping]): List of input mappings for the node.
         output_mappings (List[WorkflowNodeOutputMapping]): List of output mappings for the node.
-        function (callable): The callable node function reference if available.
-        function_name (str): The name of the function if available.
-        source_code (str): The source code of the function if available.
+        function (callable): The callable node function reference.
         input_schema (dict): The react json schema for the input form if applicable.
         output_schema (dict): The react json schema for the output if applicable.
         package_requirements (list): List of package requirements for the node.
@@ -85,9 +86,8 @@ class WorkflowGraphNode(ApiClass):
 
     def __init__(self, name: str, input_mappings: List[WorkflowNodeInputMapping], output_mappings: List[WorkflowNodeOutputMapping], function: callable = None, function_name: str = None, source_code: str = None, input_schema: dict = None, output_schema: dict = None, package_requirements: list = None):
         if function:
-            import inspect
             self.function_name = function.__name__
-            self.source_code = inspect.getsource(function)
+            self.source_code = get_clean_function_source_code(function)
         elif function_name and source_code:
             self.function_name = function_name
             self.source_code = source_code
@@ -133,8 +133,8 @@ class WorkflowGraphEdge(ApiClass):
     An edge in an Agent workflow graph.
 
     Args:
-        source (str): The source node of the edge.
-        target (str): The target node of the edge.
+        source (str): The name of the source node of the edge.
+        target (str): The name of the target node of the edge.
         details (dict): Additional details about the edge.
     """
     source: str

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/api_class/enums.py

@@ -411,6 +411,7 @@ class LLMName(ApiEnum):
     OPENAI_GPT4_VISION = 'OPENAI_GPT4_VISION'
     OPENAI_GPT3_5 = 'OPENAI_GPT3_5'
     OPENAI_GPT3_5_TEXT = 'OPENAI_GPT3_5_TEXT'
+    LLAMA3_LARGE_CHAT = 'LLAMA3_LARGE_CHAT'
     CLAUDE_V2_1 = 'CLAUDE_V2_1'
     CLAUDE_V3_OPUS = 'CLAUDE_V3_OPUS'
     CLAUDE_V3_SONNET = 'CLAUDE_V3_SONNET'
@@ -449,7 +450,6 @@ class FeatureDriftType(ApiEnum):
 
 class DataIntegrityViolationType(ApiEnum):
     NULL_VIOLATIONS = 'null_violations'
-    TYPE_MISMATCH_VIOLATIONS = 'type_mismatch_violations'
     RANGE_VIOLATIONS = 'range_violations'
     CATEGORICAL_RANGE_VIOLATION = 'categorical_range_violations'
     TOTAL_VIOLATIONS = 'total_violations'

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/api_class/model.py

@@ -383,8 +383,6 @@ class NamedEntityExtractionTrainingConfig(TrainingConfig):
     Training config for the NAMED_ENTITY_EXTRACTION problem type
 
     Args:
-        objective (NERObjective): Ranking scheme used to select final best model.
-        sort_objective (NERObjective): Ranking scheme used to sort models on the metrics page.
         llm_for_ner (NERForLLM) : LLM to use for NER from among available LLM
         test_split (int): Percent of dataset to use for test data. We support using a range between 5 ( i.e. 5% ) to 20 ( i.e. 20% ) of your dataset.
         test_row_indicator (str): Column indicating which rows to use for training (TRAIN) and testing (TEST).
@@ -394,15 +392,13 @@ class NamedEntityExtractionTrainingConfig(TrainingConfig):
         save_predicted_pdf (bool): Whether to save predicted PDF documents
         enhanced_ocr (bool): Enhanced text extraction from predicted digital documents
     """
-    objective: enums.NERObjective = dataclasses.field(default=None)
-    sort_objective: enums.NERObjective = dataclasses.field(default=None)
-    llm_for_ner: enums.LLMName = dataclasses.field(default=None)
+    llm_for_ner: enums.LLMName = None
     # Data Split Params
-    test_split: int = dataclasses.field(default=None)
-    test_row_indicator: str = dataclasses.field(default=None)
+    test_split: int = None
+    test_row_indicator: str = None
     # Named Entity Recognition
-    active_labels_column: str = dataclasses.field(default=None)
-    document_format: enums.NLPDocumentFormat = dataclasses.field(default=None)
+    active_labels_column: str = None
+    document_format: enums.NLPDocumentFormat = None
     minimum_bounding_box_overlap_ratio: float = 0.0
     # OCR
     save_predicted_pdf: bool = True

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/api_class/monitor.py

@@ -122,11 +122,15 @@ class MonitorFilteringConfig(ApiClass):
         end_time (str): The end time of the prediction time col
         restrict_feature_mapping (RestrictFeatureMappings): The feature mapping to restrict the monitor to.
         target_class (str): The target class to restrict the monitor to.
+        train_target_feature (str): Set the target feature for the training data.
+        prediction_target_feature (str): Set the target feature for the prediction data.
     """
     start_time: str = dataclasses.field(default=None)
     end_time: str = dataclasses.field(default=None)
     restrict_feature_mappings: List[RestrictFeatureMappings] = dataclasses.field(default=None)
     target_class: str = dataclasses.field(default=None)
+    train_target_feature: str = dataclasses.field(default=None)
+    prediction_target_feature: str = dataclasses.field(default=None)
 
     def to_dict(self):
         return {
@@ -134,4 +138,6 @@ class MonitorFilteringConfig(ApiClass):
             'end_time': self.end_time,
             'restrict_feature_mappings': [item.to_dict() for item in self.restrict_feature_mappings] if self.restrict_feature_mappings else None,
             'target_class': self.target_class,
+            'train_target_feature': self.train_target_feature if self.train_target_feature else None,
+            'prediction_target_feature': self.prediction_target_feature if self.prediction_target_feature else None,
         }

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/api_client_utils.py

@@ -1,10 +1,9 @@
 import importlib
-import inspect
 import json
 import os
 import re
 import string
-from textwrap import dedent
+from enum import Enum
 from typing import IO, Callable, List
 
 
@@ -19,16 +18,6 @@ def clean_column_name(column):
     return cleaned_col
 
 
-def get_clean_function_source_code(func: Callable):
-    sample_lambda = (lambda: 0)
-    if isinstance(func, type(sample_lambda)) and func.__name__ == sample_lambda.__name__:
-        raise ValueError('Lambda function not allowed.')
-    source_code = inspect.getsource(func)
-    # If function source code has some initial indentation, remove it (Ex - can happen if the functor was defined inside a function)
-    source_code = dedent(source_code)
-    return source_code
-
-
 def avro_to_pandas_dtype(avro_type):
     avro_pandas_dtypes = {
         'long': 'Int64',
@@ -186,6 +175,11 @@ def load_as_pandas_from_avro_files(files: List[str], download_method: Callable,
     return data_df
 
 
+class StreamType(Enum):
+    MESSAGE = 'message'
+    SECTION_OUTPUT = 'section_output'
+
+
 class DocstoreUtils:
     """Utility class for loading docstore data.
     Needs to be updated if docstore formats change."""

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/batch_prediction.py

@@ -22,7 +22,6 @@ class BatchPrediction(AbstractApiClass):
             fileConnectorOutputLocation (str): Contains information about where the batch predictions are written to.
             databaseConnectorId (str): The database connector to write the results to.
             databaseOutputConfiguration (dict): Contains information about where the batch predictions are written to.
-            explanations (bool): 
             fileOutputFormat (str): The format of the batch prediction output (CSV or JSON).
             connectorType (str): Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR.
             legacyInputLocation (str): The location of the input data.
@@ -44,9 +43,10 @@ class BatchPrediction(AbstractApiClass):
             latestBatchPredictionVersion (BatchPredictionVersion): The latest batch prediction version.
             refreshSchedules (RefreshSchedule): List of refresh schedules that dictate the next time the batch prediction will be run.
             inputFeatureGroups (PredictionFeatureGroup): List of prediction feature groups.
+            batchPredictionArgs (BatchPredictionArgs): Argument(s) passed to every prediction call.
     """
 
-    def __init__(self, client, batchPredictionId=None, createdAt=None, name=None, deploymentId=None, fileConnectorOutputLocation=None, databaseConnectorId=None, databaseOutputConfiguration=None, explanations=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={}):
+    def __init__(self, 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={}, batchPredictionArgs={}):
         super().__init__(client, batchPredictionId)
         self.batch_prediction_id = batchPredictionId
         self.created_at = createdAt
@@ -55,7 +55,6 @@ class BatchPrediction(AbstractApiClass):
         self.file_connector_output_location = fileConnectorOutputLocation
         self.database_connector_id = databaseConnectorId
         self.database_output_configuration = databaseOutputConfiguration
-        self.explanations = explanations
         self.file_output_format = fileOutputFormat
         self.connector_type = connectorType
         self.legacy_input_location = legacyInputLocation
@@ -80,15 +79,13 @@ class BatchPrediction(AbstractApiClass):
             RefreshSchedule, refreshSchedules)
         self.input_feature_groups = client._build_class(
             PredictionFeatureGroup, inputFeatureGroups)
-        self.global_prediction_args = client._build_class(
-            BatchPredictionArgs, globalPredictionArgs)
         self.batch_prediction_args = client._build_class(getattr(
             api_class, batchPredictionArgsType, BatchPredictionArgs) if batchPredictionArgsType else BatchPredictionArgs, batchPredictionArgs)
-        self.deprecated_keys = {'global_prediction_args', 'explanations'}
+        self.deprecated_keys = {'explanations', 'global_prediction_args'}
 
     def __repr__(self):
-        repr_dict = {f'batch_prediction_id': repr(self.batch_prediction_id), f'created_at': repr(self.created_at), f'name': repr(self.name), f'deployment_id': repr(self.deployment_id), f'file_connector_output_location': repr(self.file_connector_output_location), f'database_connector_id': repr(self.database_connector_id), f'database_output_configuration': repr(self.database_output_configuration), f'explanations': repr(self.explanations), f'file_output_format': repr(self.file_output_format), f'connector_type': repr(self.connector_type), f'legacy_input_location': repr(self.legacy_input_location), f'output_feature_group_id': repr(self.output_feature_group_id), f'feature_group_table_name': repr(self.feature_group_table_name), f'output_feature_group_table_name': repr(self.output_feature_group_table_name), f'summary_feature_group_table_name': repr(self.summary_feature_group_table_name), f'csv_input_prefix': repr(
-            self.csv_input_prefix), f'csv_prediction_prefix': repr(self.csv_prediction_prefix), f'csv_explanations_prefix': repr(self.csv_explanations_prefix), f'output_includes_metadata': repr(self.output_includes_metadata), f'result_input_columns': repr(self.result_input_columns), f'model_monitor_id': repr(self.model_monitor_id), f'model_version': repr(self.model_version), f'bp_across_versions_monitor_id': repr(self.bp_across_versions_monitor_id), f'algorithm': repr(self.algorithm), f'batch_prediction_args_type': repr(self.batch_prediction_args_type), f'batch_inputs': repr(self.batch_inputs), f'latest_batch_prediction_version': repr(self.latest_batch_prediction_version), f'refresh_schedules': repr(self.refresh_schedules), f'input_feature_groups': repr(self.input_feature_groups), f'global_prediction_args': repr(self.global_prediction_args), f'batch_prediction_args': repr(self.batch_prediction_args)}
+        repr_dict = {f'batch_prediction_id': repr(self.batch_prediction_id), f'created_at': repr(self.created_at), f'name': repr(self.name), f'deployment_id': repr(self.deployment_id), f'file_connector_output_location': repr(self.file_connector_output_location), f'database_connector_id': repr(self.database_connector_id), f'database_output_configuration': repr(self.database_output_configuration), f'file_output_format': repr(self.file_output_format), f'connector_type': repr(self.connector_type), f'legacy_input_location': repr(self.legacy_input_location), f'output_feature_group_id': repr(self.output_feature_group_id), f'feature_group_table_name': repr(self.feature_group_table_name), f'output_feature_group_table_name': repr(self.output_feature_group_table_name), f'summary_feature_group_table_name': repr(self.summary_feature_group_table_name), f'csv_input_prefix': repr(
+            self.csv_input_prefix), f'csv_prediction_prefix': repr(self.csv_prediction_prefix), f'csv_explanations_prefix': repr(self.csv_explanations_prefix), f'output_includes_metadata': repr(self.output_includes_metadata), f'result_input_columns': repr(self.result_input_columns), f'model_monitor_id': repr(self.model_monitor_id), f'model_version': repr(self.model_version), f'bp_across_versions_monitor_id': repr(self.bp_across_versions_monitor_id), f'algorithm': repr(self.algorithm), f'batch_prediction_args_type': repr(self.batch_prediction_args_type), f'batch_inputs': repr(self.batch_inputs), f'latest_batch_prediction_version': repr(self.latest_batch_prediction_version), f'refresh_schedules': repr(self.refresh_schedules), f'input_feature_groups': repr(self.input_feature_groups), f'batch_prediction_args': repr(self.batch_prediction_args)}
         class_name = "BatchPrediction"
         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])
@@ -101,8 +98,8 @@ class BatchPrediction(AbstractApiClass):
         Returns:
             dict: The dict value representation of the class parameters
         """
-        resp = {'batch_prediction_id': self.batch_prediction_id, 'created_at': self.created_at, 'name': self.name, 'deployment_id': self.deployment_id, 'file_connector_output_location': self.file_connector_output_location, 'database_connector_id': self.database_connector_id, 'database_output_configuration': self.database_output_configuration, 'explanations': self.explanations, 'file_output_format': self.file_output_format, 'connector_type': self.connector_type, 'legacy_input_location': self.legacy_input_location, 'output_feature_group_id': self.output_feature_group_id, 'feature_group_table_name': self.feature_group_table_name, 'output_feature_group_table_name': self.output_feature_group_table_name, 'summary_feature_group_table_name': self.summary_feature_group_table_name, 'csv_input_prefix': self.csv_input_prefix, 'csv_prediction_prefix': self.csv_prediction_prefix,
-                'csv_explanations_prefix': self.csv_explanations_prefix, 'output_includes_metadata': self.output_includes_metadata, 'result_input_columns': self.result_input_columns, 'model_monitor_id': self.model_monitor_id, 'model_version': self.model_version, 'bp_across_versions_monitor_id': self.bp_across_versions_monitor_id, 'algorithm': self.algorithm, 'batch_prediction_args_type': self.batch_prediction_args_type, 'batch_inputs': self._get_attribute_as_dict(self.batch_inputs), 'latest_batch_prediction_version': self._get_attribute_as_dict(self.latest_batch_prediction_version), 'refresh_schedules': self._get_attribute_as_dict(self.refresh_schedules), 'input_feature_groups': self._get_attribute_as_dict(self.input_feature_groups), 'global_prediction_args': self._get_attribute_as_dict(self.global_prediction_args), 'batch_prediction_args': self._get_attribute_as_dict(self.batch_prediction_args)}
+        resp = {'batch_prediction_id': self.batch_prediction_id, 'created_at': self.created_at, 'name': self.name, 'deployment_id': self.deployment_id, 'file_connector_output_location': self.file_connector_output_location, 'database_connector_id': self.database_connector_id, 'database_output_configuration': self.database_output_configuration, 'file_output_format': self.file_output_format, 'connector_type': self.connector_type, 'legacy_input_location': self.legacy_input_location, 'output_feature_group_id': self.output_feature_group_id, 'feature_group_table_name': self.feature_group_table_name, 'output_feature_group_table_name': self.output_feature_group_table_name, 'summary_feature_group_table_name': self.summary_feature_group_table_name, 'csv_input_prefix': self.csv_input_prefix, 'csv_prediction_prefix': self.csv_prediction_prefix,
+                'csv_explanations_prefix': self.csv_explanations_prefix, 'output_includes_metadata': self.output_includes_metadata, 'result_input_columns': self.result_input_columns, 'model_monitor_id': self.model_monitor_id, 'model_version': self.model_version, 'bp_across_versions_monitor_id': self.bp_across_versions_monitor_id, 'algorithm': self.algorithm, 'batch_prediction_args_type': self.batch_prediction_args_type, 'batch_inputs': self._get_attribute_as_dict(self.batch_inputs), 'latest_batch_prediction_version': self._get_attribute_as_dict(self.latest_batch_prediction_version), 'refresh_schedules': self._get_attribute_as_dict(self.refresh_schedules), 'input_feature_groups': self._get_attribute_as_dict(self.input_feature_groups), 'batch_prediction_args': self._get_attribute_as_dict(self.batch_prediction_args)}
         return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys}
 
     def start(self):

{abacusai-1.2.3 → abacusai-1.2.4}/abacusai/batch_prediction_version.py

@@ -11,7 +11,7 @@ class BatchPredictionVersion(AbstractApiClass):
 
         Args:
             client (ApiClient): An authenticated API Client instance
-            batchPredictionVersion (str): The unique identifier of the batch prediction
+            batchPredictionVersion (str): The unique identifier of the batch prediction version
             batchPredictionId (str): The unique identifier of the batch prediction
             status (str): The current status of the batch prediction
             driftMonitorStatus (str): The status of the drift monitor for this batch prediction version
@@ -25,7 +25,6 @@ class BatchPredictionVersion(AbstractApiClass):
             failedPredictions (int): Number of predictions that failed
             databaseConnectorId (str): The database connector to write the results to
             databaseOutputConfiguration (dict): Contains information about where the batch predictions are written to
-            explanations (bool): 
             fileConnectorOutputLocation (str):  Contains information about where the batch predictions are written to
             fileOutputFormat (str): The format of the batch prediction output (CSV or JSON)
             connectorType (str): Null if writing to internal console, else FEATURE_GROUP | FILE_CONNECTOR | DATABASE_CONNECTOR
@@ -47,12 +46,14 @@ class BatchPredictionVersion(AbstractApiClass):
             outputFeatureGroupVersion (str): The Batch Prediction output feature group version if applicable
             outputFeatureGroupTableName (str): The Batch Prediction output feature group name if applicable
             batchPredictionWarnings (str): Relevant warnings if any issues are found
+            bpAcrossVersionsMonitorVersion (str): The version of the batch prediction across versions monitor
             batchPredictionArgsType (str): The type of the batch prediction args
             batchInputs (PredictionInput): Inputs to the batch prediction
             inputFeatureGroups (PredictionFeatureGroup): List of prediction feature groups
+            batchPredictionArgs (BatchPredictionArgs): Argument(s) passed to every prediction call
     """
 
-    def __init__(self, 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, explanations=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, batchPredictionArgsType=None, batchInputs={}, inputFeatureGroups={}, globalPredictionArgs={}, batchPredictionArgs={}):
+    def __init__(self, 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={}, batchPredictionArgs={}):
         super().__init__(client, batchPredictionVersion)
         self.batch_prediction_version = batchPredictionVersion
         self.batch_prediction_id = batchPredictionId
@@ -68,7 +69,6 @@ class BatchPredictionVersion(AbstractApiClass):
         self.failed_predictions = failedPredictions
         self.database_connector_id = databaseConnectorId
         self.database_output_configuration = databaseOutputConfiguration
-        self.explanations = explanations
         self.file_connector_output_location = fileConnectorOutputLocation
         self.file_output_format = fileOutputFormat
         self.connector_type = connectorType
@@ -90,19 +90,18 @@ class BatchPredictionVersion(AbstractApiClass):
         self.output_feature_group_version = outputFeatureGroupVersion
         self.output_feature_group_table_name = outputFeatureGroupTableName
         self.batch_prediction_warnings = batchPredictionWarnings
+        self.bp_across_versions_monitor_version = bpAcrossVersionsMonitorVersion
         self.batch_prediction_args_type = batchPredictionArgsType
         self.batch_inputs = client._build_class(PredictionInput, batchInputs)
         self.input_feature_groups = client._build_class(
             PredictionFeatureGroup, inputFeatureGroups)
-        self.global_prediction_args = client._build_class(
-            BatchPredictionArgs, globalPredictionArgs)
         self.batch_prediction_args = client._build_class(getattr(
             api_class, batchPredictionArgsType, BatchPredictionArgs) if batchPredictionArgsType else BatchPredictionArgs, batchPredictionArgs)
-        self.deprecated_keys = {'global_prediction_args', 'explanations'}
+        self.deprecated_keys = {'explanations', 'global_prediction_args'}
 
     def __repr__(self):
-        repr_dict = {f'batch_prediction_version': repr(self.batch_prediction_version), f'batch_prediction_id': repr(self.batch_prediction_id), f'status': repr(self.status), f'drift_monitor_status': repr(self.drift_monitor_status), f'deployment_id': repr(self.deployment_id), f'model_id': repr(self.model_id), f'model_version': repr(self.model_version), f'predictions_started_at': repr(self.predictions_started_at), f'predictions_completed_at': repr(self.predictions_completed_at), f'database_output_error': repr(self.database_output_error), f'total_predictions': repr(self.total_predictions), f'failed_predictions': repr(self.failed_predictions), f'database_connector_id': repr(self.database_connector_id), f'database_output_configuration': repr(self.database_output_configuration), f'explanations': repr(self.explanations), f'file_connector_output_location': repr(self.file_connector_output_location), f'file_output_format': repr(self.file_output_format), f'connector_type': repr(self.connector_type), f'legacy_input_location': repr(self.legacy_input_location), f'error': repr(self.error), f'drift_monitor_error': repr(self.drift_monitor_error), f'monitor_warnings': repr(
-            self.monitor_warnings), f'csv_input_prefix': repr(self.csv_input_prefix), f'csv_prediction_prefix': repr(self.csv_prediction_prefix), f'csv_explanations_prefix': repr(self.csv_explanations_prefix), f'database_output_total_writes': repr(self.database_output_total_writes), f'database_output_failed_writes': repr(self.database_output_failed_writes), f'output_includes_metadata': repr(self.output_includes_metadata), f'result_input_columns': repr(self.result_input_columns), f'model_monitor_version': repr(self.model_monitor_version), f'algo_name': repr(self.algo_name), f'algorithm': repr(self.algorithm), f'output_feature_group_id': repr(self.output_feature_group_id), f'output_feature_group_version': repr(self.output_feature_group_version), f'output_feature_group_table_name': repr(self.output_feature_group_table_name), f'batch_prediction_warnings': repr(self.batch_prediction_warnings), f'batch_prediction_args_type': repr(self.batch_prediction_args_type), f'batch_inputs': repr(self.batch_inputs), f'input_feature_groups': repr(self.input_feature_groups), f'global_prediction_args': repr(self.global_prediction_args), f'batch_prediction_args': repr(self.batch_prediction_args)}
+        repr_dict = {f'batch_prediction_version': repr(self.batch_prediction_version), f'batch_prediction_id': repr(self.batch_prediction_id), f'status': repr(self.status), f'drift_monitor_status': repr(self.drift_monitor_status), f'deployment_id': repr(self.deployment_id), f'model_id': repr(self.model_id), f'model_version': repr(self.model_version), f'predictions_started_at': repr(self.predictions_started_at), f'predictions_completed_at': repr(self.predictions_completed_at), f'database_output_error': repr(self.database_output_error), f'total_predictions': repr(self.total_predictions), f'failed_predictions': repr(self.failed_predictions), f'database_connector_id': repr(self.database_connector_id), f'database_output_configuration': repr(self.database_output_configuration), f'file_connector_output_location': repr(self.file_connector_output_location), f'file_output_format': repr(self.file_output_format), f'connector_type': repr(self.connector_type), f'legacy_input_location': repr(self.legacy_input_location), f'error': repr(self.error), f'drift_monitor_error': repr(self.drift_monitor_error), f'monitor_warnings': repr(self.monitor_warnings), f'csv_input_prefix': repr(
+            self.csv_input_prefix), f'csv_prediction_prefix': repr(self.csv_prediction_prefix), f'csv_explanations_prefix': repr(self.csv_explanations_prefix), f'database_output_total_writes': repr(self.database_output_total_writes), f'database_output_failed_writes': repr(self.database_output_failed_writes), f'output_includes_metadata': repr(self.output_includes_metadata), f'result_input_columns': repr(self.result_input_columns), f'model_monitor_version': repr(self.model_monitor_version), f'algo_name': repr(self.algo_name), f'algorithm': repr(self.algorithm), f'output_feature_group_id': repr(self.output_feature_group_id), f'output_feature_group_version': repr(self.output_feature_group_version), f'output_feature_group_table_name': repr(self.output_feature_group_table_name), f'batch_prediction_warnings': repr(self.batch_prediction_warnings), f'bp_across_versions_monitor_version': repr(self.bp_across_versions_monitor_version), f'batch_prediction_args_type': repr(self.batch_prediction_args_type), f'batch_inputs': repr(self.batch_inputs), f'input_feature_groups': repr(self.input_feature_groups), f'batch_prediction_args': repr(self.batch_prediction_args)}
         class_name = "BatchPredictionVersion"
         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])
@@ -115,8 +114,8 @@ class BatchPredictionVersion(AbstractApiClass):
         Returns:
             dict: The dict value representation of the class parameters
         """
-        resp = {'batch_prediction_version': self.batch_prediction_version, 'batch_prediction_id': self.batch_prediction_id, 'status': self.status, 'drift_monitor_status': self.drift_monitor_status, 'deployment_id': self.deployment_id, 'model_id': self.model_id, 'model_version': self.model_version, 'predictions_started_at': self.predictions_started_at, 'predictions_completed_at': self.predictions_completed_at, 'database_output_error': self.database_output_error, 'total_predictions': self.total_predictions, 'failed_predictions': self.failed_predictions, 'database_connector_id': self.database_connector_id, 'database_output_configuration': self.database_output_configuration, 'explanations': self.explanations, 'file_connector_output_location': self.file_connector_output_location, 'file_output_format': self.file_output_format, 'connector_type': self.connector_type, 'legacy_input_location': self.legacy_input_location, 'error': self.error, 'drift_monitor_error': self.drift_monitor_error, 'monitor_warnings': self.monitor_warnings, 'csv_input_prefix': self.csv_input_prefix,
-                'csv_prediction_prefix': self.csv_prediction_prefix, 'csv_explanations_prefix': self.csv_explanations_prefix, 'database_output_total_writes': self.database_output_total_writes, 'database_output_failed_writes': self.database_output_failed_writes, 'output_includes_metadata': self.output_includes_metadata, 'result_input_columns': self.result_input_columns, 'model_monitor_version': self.model_monitor_version, 'algo_name': self.algo_name, 'algorithm': self.algorithm, 'output_feature_group_id': self.output_feature_group_id, 'output_feature_group_version': self.output_feature_group_version, 'output_feature_group_table_name': self.output_feature_group_table_name, 'batch_prediction_warnings': self.batch_prediction_warnings, 'batch_prediction_args_type': self.batch_prediction_args_type, 'batch_inputs': self._get_attribute_as_dict(self.batch_inputs), 'input_feature_groups': self._get_attribute_as_dict(self.input_feature_groups), 'global_prediction_args': self._get_attribute_as_dict(self.global_prediction_args), 'batch_prediction_args': self._get_attribute_as_dict(self.batch_prediction_args)}
+        resp = {'batch_prediction_version': self.batch_prediction_version, 'batch_prediction_id': self.batch_prediction_id, 'status': self.status, 'drift_monitor_status': self.drift_monitor_status, 'deployment_id': self.deployment_id, 'model_id': self.model_id, 'model_version': self.model_version, 'predictions_started_at': self.predictions_started_at, 'predictions_completed_at': self.predictions_completed_at, 'database_output_error': self.database_output_error, 'total_predictions': self.total_predictions, 'failed_predictions': self.failed_predictions, 'database_connector_id': self.database_connector_id, 'database_output_configuration': self.database_output_configuration, 'file_connector_output_location': self.file_connector_output_location, 'file_output_format': self.file_output_format, 'connector_type': self.connector_type, 'legacy_input_location': self.legacy_input_location, 'error': self.error, 'drift_monitor_error': self.drift_monitor_error, 'monitor_warnings': self.monitor_warnings, 'csv_input_prefix': self.csv_input_prefix, 'csv_prediction_prefix':
+                self.csv_prediction_prefix, 'csv_explanations_prefix': self.csv_explanations_prefix, 'database_output_total_writes': self.database_output_total_writes, 'database_output_failed_writes': self.database_output_failed_writes, 'output_includes_metadata': self.output_includes_metadata, 'result_input_columns': self.result_input_columns, 'model_monitor_version': self.model_monitor_version, 'algo_name': self.algo_name, 'algorithm': self.algorithm, 'output_feature_group_id': self.output_feature_group_id, 'output_feature_group_version': self.output_feature_group_version, 'output_feature_group_table_name': self.output_feature_group_table_name, 'batch_prediction_warnings': self.batch_prediction_warnings, 'bp_across_versions_monitor_version': self.bp_across_versions_monitor_version, 'batch_prediction_args_type': self.batch_prediction_args_type, 'batch_inputs': self._get_attribute_as_dict(self.batch_inputs), 'input_feature_groups': self._get_attribute_as_dict(self.input_feature_groups), 'batch_prediction_args': self._get_attribute_as_dict(self.batch_prediction_args)}
         return {key: value for key, value in resp.items() if value is not None and key not in self.deprecated_keys}
 
     def download_batch_prediction_result_chunk(self, offset: int = 0, chunk_size: int = 10485760):