abacusai.external_application
=============================

.. py:module:: abacusai.external_application


Classes
-------

.. autoapisummary::

   abacusai.external_application.ExternalApplication


Module Contents
---------------

.. py:class:: ExternalApplication(client, name=None, externalApplicationId=None, deploymentId=None, description=None, logo=None, theme=None, userGroupIds=None, useCase=None, isAgent=None, status=None, deploymentConversationRetentionHours=None, managedUserService=None, predictionOverrides=None, isSystemCreated=None, isCustomizable=None, isDeprecated=None, isVisible=None, hasThinkingOption=None, onlyImageGenEnabled=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 isAgent: Whether the external application is an agent.
   :type isAgent: bool
   :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
   :param isSystemCreated: Whether the external application is system created.
   :type isSystemCreated: bool
   :param isCustomizable: Whether the external application is customizable.
   :type isCustomizable: bool
   :param isDeprecated: Whether the external application is deprecated. Only applicable for system created bots. Deprecated external applications will not show in the UI.
   :type isDeprecated: bool
   :param isVisible: Whether the external application should be shown in the dropdown.
   :type isVisible: bool
   :param hasThinkingOption: Whether to show the thinking option in the toolbar.
   :type hasThinkingOption: bool
   :param onlyImageGenEnabled: Whether to LLM only allows image generation.
   :type onlyImageGenEnabled: bool


   .. py:attribute:: name
      :value: None



   .. py:attribute:: external_application_id
      :value: None



   .. py:attribute:: deployment_id
      :value: None



   .. py:attribute:: description
      :value: None



   .. py:attribute:: logo
      :value: None



   .. py:attribute:: theme
      :value: None



   .. py:attribute:: user_group_ids
      :value: None



   .. py:attribute:: use_case
      :value: None



   .. py:attribute:: is_agent
      :value: None



   .. py:attribute:: status
      :value: None



   .. py:attribute:: deployment_conversation_retention_hours
      :value: None



   .. py:attribute:: managed_user_service
      :value: None



   .. py:attribute:: prediction_overrides
      :value: None



   .. py:attribute:: is_system_created
      :value: None



   .. py:attribute:: is_customizable
      :value: None



   .. py:attribute:: is_deprecated
      :value: None



   .. py:attribute:: is_visible
      :value: None



   .. py:attribute:: has_thinking_option
      :value: None



   .. py:attribute:: only_image_gen_enabled
      :value: None



   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. 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