abacusai 1.2.8__tar.gz → 1.2.9__tar.gz

{abacusai-1.2.8/abacusai.egg-info → abacusai-1.2.9}/PKG-INFO

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

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/agent.py

@@ -104,7 +104,7 @@ class Agent(AbstractApiClass):
         A waiting call until agent is published.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         latest_agent_version = self.describe().latest_agent_version
         if not latest_agent_version:

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/agent_version.py

@@ -85,7 +85,7 @@ class AgentVersion(AbstractApiClass):
         A waiting call until agent gets published.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         return self.client._poll(self, {'PENDING', 'PUBLISHING'}, delay=30, timeout=timeout)
 

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_class/ai_agents.py

@@ -82,7 +82,7 @@ class WorkflowNodeInputMapping(ApiClass):
                                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.
+        is_required (bool): Whether the input is required. Defaults to True
     """
     name: str
     variable_type: enums.WorkflowNodeInputType
@@ -143,8 +143,8 @@ class WorkflowGraphNode(ApiClass):
         input_mappings (List[WorkflowNodeInputMapping]): List of input mappings for the node. Each arg/kwarg of the node function should have a corresponding input mapping.
         output_mappings (List[WorkflowNodeOutputMapping]): List of output mappings for the node. Each field in the returned dict/AgentResponse must have a corresponding output mapping.
         function (callable): The callable node function reference.
-        input_schema (WorkflowNodeInputSchema): The react json schema for the input form if applicable.
-        output_schema (WorkflowNodeOutputSchema): The react json schema for the output if applicable.
+        input_schema (WorkflowNodeInputSchema): The react json schema for the user input variables.
+        output_schema (WorkflowNodeOutputSchema): The react json schema for the output to be shown on UI.
         package_requirements (list): List of package requirements for the node.
     """
 

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_class/dataset_application_connector.py

@@ -27,9 +27,9 @@ class ConfluenceDatasetConfig(DatasetConfig):
     Dataset config for Confluence Application Connector
     Args:
         location (str): The location of the pages to fetch
-        pull_attachments (bool, optional): Whether to pull attachments for each page
-        space_key (str, optional): The space key to fetch pages from
-        extract_bounding_boxes (bool, optional): Whether to extract bounding boxes from the documents
+        pull_attachments (bool): Whether to pull attachments for each page
+        space_key (str): The space key to fetch pages from
+        extract_bounding_boxes (bool): Whether to extract bounding boxes from the documents
 
     """
     location: str = dataclasses.field(default=None)
@@ -48,8 +48,8 @@ class GoogleAnalyticsDatasetConfig(DatasetConfig):
 
     Args:
         location (str): The view id of the report in the connector to fetch
-        start_timestamp (int, optional): Unix timestamp of the start of the period that will be queried
-        end_timestamp (int, optional): Unix timestamp of the end of the period that will be queried
+        start_timestamp (int): Unix timestamp of the start of the period that will be queried
+        end_timestamp (int): Unix timestamp of the end of the period that will be queried
     """
     location: str = dataclasses.field(default=None)
     start_timestamp: int = dataclasses.field(default=None)
@@ -66,9 +66,9 @@ class GoogleDriveDatasetConfig(DatasetConfig):
 
     Args:
         location (str): The regex location of the files to fetch
-        csv_delimiter (str, optional): If the file format is CSV, use a specific csv delimiter
-        extract_bounding_boxes (bool, optional): Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
-        merge_file_schemas (bool, optional): Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
+        csv_delimiter (str): If the file format is CSV, use a specific csv delimiter
+        extract_bounding_boxes (bool): Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
+        merge_file_schemas (bool): Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
     """
     location: str = dataclasses.field(default=None)
     csv_delimiter: str = dataclasses.field(default=None)
@@ -86,9 +86,9 @@ class JiraDatasetConfig(DatasetConfig):
 
     Args:
         jql (str): The JQL query for fetching issues
-        custom_fields (list, optional): A list of custom fields to include in the dataset
-        include_comments (bool, optional): Fetch comments for each issue
-        include_watchers (bool, optional): Fetch watchers for each issue
+        custom_fields (list): A list of custom fields to include in the dataset
+        include_comments (bool): Fetch comments for each issue
+        include_watchers (bool): Fetch watchers for each issue
     """
     jql: str = dataclasses.field(default=None)
     custom_fields: list = dataclasses.field(default=None)
@@ -106,9 +106,9 @@ class OneDriveDatasetConfig(DatasetConfig):
 
     Args:
         location (str): The regex location of the files to fetch
-        csv_delimiter (str, optional): If the file format is CSV, use a specific csv delimiter
-        extract_bounding_boxes (bool, optional): Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
-        merge_file_schemas (bool, optional): Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
+        csv_delimiter (str): If the file format is CSV, use a specific csv delimiter
+        extract_bounding_boxes (bool): Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
+        merge_file_schemas (bool): Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
     """
     location: str = dataclasses.field(default=None)
     csv_delimiter: str = dataclasses.field(default=None)
@@ -127,9 +127,9 @@ class SharepointDatasetConfig(DatasetConfig):
     Args:
         location (str): The regex location of the files to fetch
         is_documentset (bool): Whether the dataset is a document set
-        csv_delimiter (str, optional): If the file format is CSV, use a specific csv delimiter
-        extract_bounding_boxes (bool, optional): Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
-        merge_file_schemas (bool, optional): Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
+        csv_delimiter (str): If the file format is CSV, use a specific csv delimiter
+        extract_bounding_boxes (bool): Signifies whether to extract bounding boxes out of the documents. Only valid if is_documentset if True
+        merge_file_schemas (bool): Signifies if the merge file schema policy is enabled. Not applicable if is_documentset is True
     """
     location: str = dataclasses.field(default=None)
     csv_delimiter: str = dataclasses.field(default=None)

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_class/enums.py

@@ -410,6 +410,7 @@ class LLMName(ApiEnum):
     OPENAI_GPT4_128K = 'OPENAI_GPT4_128K'
     OPENAI_GPT4_128K_LATEST = 'OPENAI_GPT4_128K_LATEST'
     OPENAI_GPT4_VISION = 'OPENAI_GPT4_VISION'
+    OPENAI_GPT4O = 'OPENAI_GPT4O'
     OPENAI_GPT3_5 = 'OPENAI_GPT3_5'
     OPENAI_GPT3_5_TEXT = 'OPENAI_GPT3_5_TEXT'
     LLAMA3_LARGE_CHAT = 'LLAMA3_LARGE_CHAT'

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_class/model.py

@@ -69,7 +69,7 @@ class PersonalizationTrainingConfig(TrainingConfig):
     # top-level params
     objective: enums.PersonalizationObjective = dataclasses.field(default=None)
     sort_objective: enums.PersonalizationObjective = dataclasses.field(default=None)
-    training_mode: enums.PersonalizationTrainingMode = dataclasses.field(default=enums.PersonalizationTrainingMode.EXPERIMENTAL)
+    training_mode: enums.PersonalizationTrainingMode = dataclasses.field(default=None)
 
     # advanced options
     # interactions
@@ -173,7 +173,7 @@ class RegressionTrainingConfig(TrainingConfig):
     """
     objective: enums.RegressionObjective = dataclasses.field(default=None)
     sort_objective: enums.RegressionObjective = dataclasses.field(default=None)
-    tree_hpo_mode: enums.RegressionTreeHPOMode = dataclasses.field(default=enums.RegressionTreeHPOMode.THOROUGH)
+    tree_hpo_mode: enums.RegressionTreeHPOMode = dataclasses.field(default=None)
     partial_dependence_analysis: enums.PartialDependenceAnalysis = dataclasses.field(default=None)
 
     # data split related
@@ -715,15 +715,12 @@ class AIAgentTrainingConfig(TrainingConfig):
     Args:
         description (str): Description of the agent function.
         agent_interface (AgentInterface): The interface that the agent will be deployed with.
-        enable_binary_input (bool): If True, the agent will be able to accept binary data as inputs.
-        agent_input_schema (dict): Schema for the agent input.
-        agent_output_schema (dict): Schema for the agent output.
     """
     description: str = dataclasses.field(default=None)
-    agent_interface: enums.AgentInterface = dataclasses.field(default=enums.AgentInterface.DEFAULT)
-    enable_binary_input: bool = dataclasses.field(default=None)
-    agent_input_schema: dict = dataclasses.field(default=None)
-    agent_output_schema: dict = dataclasses.field(default=None)
+    agent_interface: enums.AgentInterface = dataclasses.field(default=None)
+    enable_binary_input: bool = dataclasses.field(default=None, metadata={'deprecated': True})
+    agent_input_schema: dict = dataclasses.field(default=None, metadata={'deprecated': True})
+    agent_output_schema: dict = dataclasses.field(default=None, metadata={'deprecated': True})
 
     def __post_init__(self):
         self.problem_type = enums.ProblemType.AI_AGENT

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_class/monitor.py

@@ -100,15 +100,27 @@ class RestrictFeatureMappings(ApiClass):
 
     Args:
         feature_name (str): The name of the feature to restrict the monitor to.
-        restricted_feature_values (list): The values of the feature to restrict the monitor to.
+        restricted_feature_values (list): The values of the feature to restrict the monitor to if feature is a categorical.
+        start_time (str): The start time of the timestamp feature to filter from
+        end_time (str): The end time of the timestamp feature to filter until
+        min_value (float): Value to filter the numerical feature above
+        max_value (float): Filtering the numerical feature to below this value
     """
     feature_name: str = dataclasses.field(default=None)
     restricted_feature_values: list = dataclasses.field(default_factory=list)
+    start_time: str = dataclasses.field(default=None)
+    end_time: str = dataclasses.field(default=None)
+    min_value: float = dataclasses.field(default=None)
+    max_value: float = dataclasses.field(default=None)
 
     def to_dict(self):
         return {
             'feature_name': self.feature_name,
             'restricted_feature_values': self.restricted_feature_values,
+            'start_time': self.start_time,
+            'end_time': self.end_time,
+            'min_value': self.min_value,
+            'max_value': self.max_value,
         }
 
 
@@ -120,7 +132,7 @@ class MonitorFilteringConfig(ApiClass):
     Args:
         start_time (str): The start time of the prediction time col
         end_time (str): The end time of the prediction time col
-        restrict_feature_mapping (RestrictFeatureMappings): The feature mapping to restrict the monitor to.
+        restrict_feature_mappings (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.

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_class/project.py

@@ -49,13 +49,13 @@ class ConstraintConfig(ApiClass):
     Args:
         constant (float): The constant value for the constraint.
         operator (str): The operator for the constraint. Could be 'EQ', 'LE', 'GE'
-        enforcement (str): The enforcement for the constraint. Could be 'HARD' or 'SOFT'
+        enforcement (str): The enforcement for the constraint. Could be 'HARD' or 'SOFT'. Default is 'HARD'
         code (str): The code for the constraint.
         penalty (float): The penalty for violating the constraint.
     """
     constant: float
     operator: str
-    enforcement: str
+    enforcement: Optional[str] = dataclasses.field(default=None)
     code: Optional[str] = dataclasses.field(default=None)
     penalty: Optional[float] = dataclasses.field(default=None)
 

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/api_client_utils.py

@@ -50,7 +50,7 @@ def get_non_nullable_type(types):
 
 
 class StreamingHandler(str):
-    def __new__(cls, value, context=None, section_key=None, data_type='text/plain'):
+    def __new__(cls, value, context=None, section_key=None, data_type='text'):
         if context:
             cls.process_streaming_data(value, context, section_key, data_type)
         return str.__new__(cls, value)
@@ -70,7 +70,7 @@ class StreamingHandler(str):
                     break
             if not entry_exists:
                 context.streamed_section_response.append(
-                    {'id': section_key, 'type': data_type, 'contents': value})
+                    {'id': section_key, 'type': data_type, 'mime_type': 'text/plain', 'contents': value})
         elif hasattr(context, 'streamed_response') and isinstance(context.streamed_response, list) and isinstance(value, str):
             context.streamed_response.append(value)
 

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/batch_prediction.py

@@ -84,7 +84,7 @@ class BatchPrediction(AbstractApiClass):
             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'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(
@@ -261,7 +261,7 @@ class BatchPrediction(AbstractApiClass):
         A waiting call until batch predictions are ready.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         return self.client._poll(self, {'PENDING', 'UPLOADING', 'PREDICTING'}, timeout=timeout)
 
@@ -270,7 +270,7 @@ class BatchPrediction(AbstractApiClass):
         A waiting call until batch prediction drift monitor calculations are ready.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         if self.describe().latest_batch_prediction_version:
             return self.describe().latest_batch_prediction_version.wait_for_drift_monitor(timeout=timeout)

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/batch_prediction_version.py

@@ -100,7 +100,7 @@ class BatchPredictionVersion(AbstractApiClass):
             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'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(
@@ -194,7 +194,7 @@ class BatchPredictionVersion(AbstractApiClass):
         A waiting call until batch prediction version is ready.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         return self.client._poll(self, {'PENDING', 'UPLOADING', 'PREDICTING'}, timeout=timeout)
 
@@ -203,7 +203,7 @@ class BatchPredictionVersion(AbstractApiClass):
         A waiting call until batch prediction drift monitor calculations are ready.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         return self.client._poll(self, {'PENDING', 'MONITORING'}, poll_args={'drift_monitor_status': True}, timeout=timeout)
 

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/client.py

@@ -13,7 +13,7 @@ import time
 import warnings
 from copy import deepcopy
 from functools import lru_cache
-from typing import Callable, Dict, List, Union
+from typing import Any, Callable, Dict, List, Union
 from uuid import uuid4
 
 import pandas as pd
@@ -177,7 +177,7 @@ DEFAULT_SERVER = 'https://api.abacus.ai'
 _request_context = threading.local()
 
 
-def _is_json_serializable(object: any):
+def _is_json_serializable(object: Any):
     """
     Tests if an object is JSON serializable.
 
@@ -2540,15 +2540,16 @@ class ReadOnlyClient(BaseApiClient):
             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)
 
-    def list_deployment_conversations(self, deployment_id: str) -> List[DeploymentConversation]:
+    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.
 
         Args:
             deployment_id (str): The deployment to get conversations for.
+            external_application_id (str): The external application id associated with the deployment conversation. If specified, only conversations created on that application will be listed.
 
         Returns:
             list[DeploymentConversation]: The deployment conversations."""
-        return self._proxy_request('listDeploymentConversations', 'GET', query_params={'deploymentId': deployment_id}, parse_type=DeploymentConversation, is_sync=True)
+        return self._proxy_request('listDeploymentConversations', 'GET', query_params={'deploymentId': deployment_id, 'externalApplicationId': external_application_id}, parse_type=DeploymentConversation, is_sync=True)
 
     def export_deployment_conversation(self, deployment_conversation_id: str = None, external_session_id: str = None) -> DeploymentConversationExport:
         """Export a Deployment Conversation.
@@ -2651,17 +2652,6 @@ class ReadOnlyClient(BaseApiClient):
             list[AgentVersion]: An array of Agent versions."""
         return self._call_api('listAgentVersions', 'GET', query_params={'agentId': agent_id, 'limit': limit, 'startAfterVersion': start_after_version}, parse_type=AgentVersion)
 
-    def get_llm_app_response(self, llm_app_name: str, prompt: str) -> LlmResponse:
-        """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.
-
-        Args:
-            llm_app_name (str): The name of the LLM App to use for generation.
-            prompt (str): The prompt to use for generation.
-
-        Returns:
-            LlmResponse: The response from the LLM App."""
-        return self._call_api('getLLMAppResponse', 'GET', query_params={'llmAppName': llm_app_name, 'prompt': prompt}, parse_type=LlmResponse)
-
     def list_llm_apps(self) -> List[LlmApp]:
         """Lists all available LLM Apps, which are LLMs tailored to achieve a specific task like code generation for a specific service's API.
 
@@ -2886,7 +2876,7 @@ class ApiClient(ReadOnlyClient):
             df (pyspark.sql.DataFrame): The dataframe to upload
             table_name (str): The table name to assign to the feature group created by this call
             should_wait_for_upload (bool): Wait for dataframe to upload before returning. Some FeatureGroup methods, like materialization, may not work until upload is complete.
-            timeout (int, optional): If waiting for upload, time out after this limit.
+            timeout (int): If waiting for upload, time out after this limit.
         """
         feature_group = self.describe_feature_group_by_table_name(table_name)
         if feature_group.feature_group_source_type != 'DATASET':
@@ -2919,14 +2909,14 @@ class ApiClient(ReadOnlyClient):
         Create a new prediction operator.
 
         Args:
-            prediction_operator_id (str): The unique ID of the prediction operator.
             name (str): Name of the prediction operator.
-            function_source_code (str): Contents of a valid Python source code file. The source code should contain the function `predictFunctionName`, and the function 'initializeFunctionName' if defined.
-            predict_function_name (str): Name of the optional initialize function found in the source code. This function will generate anything used by predictions, based on input feature groups.
-            predict_function_name (str): Name of the function found in the source code that will be executed to run predictions.
+            project_id (str): The unique ID of the associated project.
+            predict_function (callable): The function that will be executed to run predictions.
+            initialize_function (callable): The initialization function that can generate anything used by predictions, based on input feature groups.
             feature_group_ids (list): List of feature groups that are supplied to the initialize function as parameters. Each of the parameters are materialized Dataframes.
             cpu_size (str): Size of the CPU for the prediction operator.
             memory (int): Memory (in GB) for the  prediction operator.
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
             package_requirements (list): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
             use_gpu (bool): Whether this rediction operator needs gpu.
         Returns
@@ -2956,15 +2946,15 @@ class ApiClient(ReadOnlyClient):
         Update an existing prediction operator.
 
         Args:
+            prediction_operator_id (str): The unique ID of the prediction operator.
             name (str): The name of the prediction operator
-            project_id (str): The project to create the prediction in
             predict_function (callable): The predict function callable to serialize and upload
             initialize_function (callable): The initialize function callable to serialize and upload
-            initialize_input_tables (list): The input table names of the feature groups to pass to the train function
+            feature_group_ids (list): 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.
             cpu_size (str): Size of the cpu for the training function
             memory (int): Memory (in GB) for the training function
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
             use_gpu (bool): Whether this prediction needs gpu
         """
         function_source_code = None
@@ -2996,8 +2986,10 @@ class ApiClient(ReadOnlyClient):
             training_input_tables (list): The input table names of the feature groups to pass to the train function
             cpu_size (str): Size of the cpu for the training function
             memory (int): Memory (in GB) for the training function
+            training_config (TrainingConfig): Training configuration
+            exclusive_run (bool): Decides if this model will be run exclusively or along with other Abacus.AI algorithms
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
             name (str): The name of the model
             use_gpu (bool): Whether this model needs gpu
             is_thread_safe (bool): Whether the model is thread safe
@@ -3022,7 +3014,7 @@ class ApiClient(ReadOnlyClient):
             cpu_size (str): Size of the cpu for the training function
             memory (int): Memory (in GB) for the training function
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
             use_gpu (bool): Whether this model needs gpu
             is_thread_safe (bool): Whether the model is thread safe
         """
@@ -3057,7 +3049,7 @@ class ApiClient(ReadOnlyClient):
             package_requirements (list): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0'].
             cpu_size (str): Size of the CPU for the step function.
             memory (int): Memory (in GB) for the step function.
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
             timeout (int): Timeout for how long the step can run in minutes, default is 300 minutes.
         """
         source_code = get_clean_function_source_code(function)
@@ -3099,7 +3091,7 @@ class ApiClient(ReadOnlyClient):
             package_requirements (list): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0'].
             cpu_size (str): Size of the CPU for the step function.
             memory (int): Memory (in GB) for the step function.
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
             timeout (int): Timeout for the step in minutes, default is 300 minutes.
         """
         source_code = get_clean_function_source_code(function)
@@ -3161,7 +3153,7 @@ class ApiClient(ReadOnlyClient):
             cpu_size (str): Size of the cpu for the feature group function
             memory (int): Memory (in GB) for the feature group function
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
         """
         function_source = None
         function_name = None
@@ -3182,7 +3174,7 @@ class ApiClient(ReadOnlyClient):
             function (callable): The function callable to serialize and upload.
             function_variable_mappings (List<PythonFunctionArguments>): List of python function arguments
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
         Returns:
             PythonFunction: The python_function object.
         """
@@ -3205,11 +3197,11 @@ class ApiClient(ReadOnlyClient):
             training_data_parameter_names_mapping (Dict): The mapping from feature group types to training data parameter names in the train function
             training_config_parameter_name (string): The train config parameter name in the train function
             config_options (Dict): Map dataset types and configs to train function parameter names
-            is_default_enabled: Whether train with the algorithm by default
+            is_default_enabled (bool): Whether train with the algorithm by default
             project_id (Unique String Identifier): The unique version ID of the project
             use_gpu (Boolean): Whether this algorithm needs to run on GPU
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
         """
         source_code, train_function_name, predict_function_name, predict_many_function_name, initialize_function_name = get_source_code_info(
             train_function, predict_function, predict_many_function, initialize_function, common_functions)
@@ -3247,7 +3239,7 @@ class ApiClient(ReadOnlyClient):
             is_default_enabled (Boolean): Whether train with the algorithm by default
             use_gpu (Boolean): Whether this algorithm needs to run on GPU
             package_requirements (List): List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0']
-            included_modules (list): A list of user-created modules that will be included, which is equivalent to 'from module import *'
+            included_modules (list): List of names of user-created modules that will be included, which is equivalent to 'from module import *'
 
         """
         source_code, train_function_name, predict_function_name, predict_many_function_name, initialize_function_name = get_source_code_info(
@@ -3267,7 +3259,7 @@ class ApiClient(ReadOnlyClient):
             use_gpu=use_gpu,
             package_requirements=package_requirements)
 
-    def get_train_function_input(self, project_id: str, training_table_names: list = None, training_data_parameter_name_override: dict = None, training_config_parameter_name_override: str = None, training_config: dict = None, custom_algorithm_config: any = None):
+    def get_train_function_input(self, project_id: str, training_table_names: list = None, training_data_parameter_name_override: dict = None, training_config_parameter_name_override: str = None, training_config: dict = None, custom_algorithm_config: Any = None):
         """
         Get the input data for the train function to test locally.
 
@@ -3294,7 +3286,7 @@ class ApiClient(ReadOnlyClient):
         input[training_config_parameter_name] = train_function_info.training_config
         return input
 
-    def get_train_function_input_from_model_version(self, model_version: str, algorithm: str = None, training_config: dict = None, custom_algorithm_config: any = None):
+    def get_train_function_input_from_model_version(self, model_version: str, algorithm: str = None, training_config: dict = None, custom_algorithm_config: Any = None):
         """
         Get the input data for the train function to test locally, based on a trained model version.
 
@@ -3740,21 +3732,22 @@ class ApiClient(ReadOnlyClient):
                 request_id, caller, message=message, extra_args=extra_args, proxy_caller=proxy_caller)
         return StreamingHandler(message, _request_context)
 
-    def stream_section_output(self, section_key: str, value, value_type: str = 'text/plain') -> None:
+    def stream_section_output(self, section_key: str, value: Any, value_type: str = 'text') -> None:
         """
         Streams value corresponding to a particular section to the current request context. Applicable within a AIAgent execute function.
         If the request is from the abacus.ai app, the response will be streamed to the UI. otherwise would be logged info if used from notebook or python script.
 
         Args:
             section_key (str): The section key to which the output corresponds.
-            value: The output contents.
+            value (Any): The output contents.
             value_type (str): The mime type of the output contents.
         """
         request_id = self._get_agent_app_request_id()
         caller = self._get_agent_async_app_caller()
         proxy_caller = self._is_proxy_app_caller()
         if _is_json_serializable(value):
-            message_args = {'id': section_key, 'mime_type': value_type}
+            message_args = {'id': section_key,
+                            'type': value_type, 'mime_type': 'text/plain'}
         else:
             raise ValueError('The value is not json serializable')
         if request_id and caller:
@@ -3780,7 +3773,8 @@ class ApiClient(ReadOnlyClient):
         if section_key:
             extra_args = {
                 'stream_type': StreamType.SECTION_OUTPUT.value, 'response_version': '2.0'}
-            message_args = {'id': section_key, 'mime_type': 'text/plain'}
+            message_args = {'id': section_key,
+                            'type': 'text', 'mime_type': 'text/plain'}
         if hasattr(_request_context, 'agent_workflow_node_id'):
             extra_args.update(
                 {'agent_workflow_node_id': _request_context.agent_workflow_node_id})
@@ -3857,6 +3851,8 @@ class ApiClient(ReadOnlyClient):
             temperature (float): The temperature to use for the language model if supported. If not provided, the default temperature is used.
             preview (bool): If True, a preview of the query execution is returned.
             schema_document_retriever_ids (List[str]): A list of document retrievers to retrieve schema information for the data query. Otherwise, they are retrieved from the feature group metadata.
+            timeout (int): Time limit for the call.
+            delay (int): Polling interval for checking timeout.
 
         Returns:
             LlmExecutionResult: The result of the query execution. Execution results could be loaded as pandas using 'load_as_pandas', i.e., result.execution.load_as_pandas().
@@ -5555,7 +5551,7 @@ Creates a new feature group defined as the union of other feature group versions
             doc_id (str): A unique Docstore string identifier for the document.
             document_processing_config (DocumentProcessingConfig): The document processing configuration to use for returning the data. If not provided, the latest available data or the default configuration will be used.
             document_processing_version (str): The document processing version to use for returning the data. If not provided, the latest version will be used.
-            return_extracted_page_text (bool): (Optional) Whether to return list of extracted text for each page.
+            return_extracted_page_text (bool): Specifies whether to include a list of extracted text for each page in the response. Defaults to false if not provided.
 
         Returns:
             DocumentData: The extracted document data."""
@@ -5568,9 +5564,9 @@ Creates a new feature group defined as the union of other feature group versions
             document (io.TextIOBase): The document to extract data from. One of document or doc_id must be provided.
             doc_id (str): A unique Docstore string identifier for the document. One of document or doc_id must be provided.
             document_processing_config (DocumentProcessingConfig): The document processing configuration.
-            start_page (int): (Optional) The starting page to extract data from. Pages are indexed starting from 0. If not provided, the first page will be used.
-            end_page (int): (Optional) The last page to extract data from. Pages are indexed starting from 0. If not provided, the last page will be used.
-            return_extracted_page_text (bool): (Optional) Whether to return list of extracted text for each page.
+            start_page (int): The starting page to extract data from. Pages are indexed starting from 0. If not provided, the first page will be used.
+            end_page (int): The last page to extract data from. Pages are indexed starting from 0. If not provided, the last page will be used.
+            return_extracted_page_text (bool): Specifies whether to include a list of extracted text for each page in the response. Defaults to false if not provided.
 
         Returns:
             DocumentData: The extracted document data."""
@@ -7351,7 +7347,7 @@ Creates a new feature group defined as the union of other feature group versions
         """Gets a list of feature group row processes.
 
         Args:
-            deployment_id (str):  The deployment id for the process
+            deployment_id (str): The deployment id for the process
             limit (int): The maximum number of processes to return. Defaults to None.
             status (str): The status of the processes to return. Defaults to None.
 
@@ -8204,6 +8200,17 @@ Creates a new feature group defined as the union of other feature group versions
             ChatMessage: A list of ChatMessage that represents the conversation."""
         return self._proxy_request('constructAgentConversationMessagesForLLM', 'POST', query_params={}, body={'currentMessage': current_message, 'currentDocIds': current_doc_ids, 'includeHistory': include_history, 'includeDocumentContents': include_document_contents, 'deploymentConversationId': deployment_conversation_id, 'externalSessionId': external_session_id, 'maxDocumentWords': max_document_words}, parse_type=ChatMessage, is_sync=True)
 
+    def get_llm_app_response(self, llm_app_name: str, prompt: str) -> LlmResponse:
+        """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.
+
+        Args:
+            llm_app_name (str): The name of the LLM App to use for generation.
+            prompt (str): The prompt to use for generation.
+
+        Returns:
+            LlmResponse: The response from the LLM App."""
+        return self._call_api('getLLMAppResponse', 'POST', query_params={}, body={'llmAppName': llm_app_name, 'prompt': prompt}, parse_type=LlmResponse)
+
     def create_document_retriever(self, project_id: str, name: str, feature_group_id: str, document_retriever_config: Union[dict, DocumentRetrieverConfig] = None) -> DocumentRetriever:
         """Returns a document retriever that stores embeddings for document chunks in a feature group.
 

{abacusai-1.2.8 → abacusai-1.2.9}/abacusai/dataset.py

@@ -264,7 +264,7 @@ class Dataset(AbstractApiClass):
         A waiting call until dataset is imported.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
 
         """
         latest_dataset_version = self.describe().latest_dataset_version
@@ -280,7 +280,7 @@ class Dataset(AbstractApiClass):
         A waiting call until dataset is completely inspected.
 
         Args:
-            timeout (int, optional): 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.
+            timeout (int): 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.
         """
         latest_dataset_version = self.describe().latest_dataset_version
         if not latest_dataset_version: