abacusai.chat_session
=====================

.. py:module:: abacusai.chat_session


Classes
-------

.. autoapisummary::

   abacusai.chat_session.ChatSession


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

.. py:class:: ChatSession(client, answer=None, chatSessionId=None, projectId=None, name=None, createdAt=None, status=None, aiBuildingInProgress=None, notification=None, whiteboard=None, chatHistory={}, nextAiBuildingTask={})

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   A chat session with Abacus Data Science Co-pilot.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param answer: The response from the chatbot
   :type answer: str
   :param chatSessionId: The chat session id
   :type chatSessionId: str
   :param projectId: The project id associated with the chat session
   :type projectId: str
   :param name: The name of the chat session
   :type name: str
   :param createdAt: The timestamp at which the chat session was created
   :type createdAt: str
   :param status: The status of the chat sessions
   :type status: str
   :param aiBuildingInProgress: Whether the AI building is in progress or not
   :type aiBuildingInProgress: bool
   :param notification: A warn/info message about the chat session. For example, a suggestion to create a new session if the current one is too old
   :type notification: str
   :param whiteboard: A set of whiteboard notes associated with the chat session
   :type whiteboard: str
   :param chatHistory: The chat history for the conversation
   :type chatHistory: ChatMessage
   :param nextAiBuildingTask: The next AI building task for the chat session
   :type nextAiBuildingTask: AiBuildingTask


   .. py:attribute:: answer
      :value: None



   .. py:attribute:: chat_session_id
      :value: None



   .. py:attribute:: project_id
      :value: None



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



   .. py:attribute:: created_at
      :value: None



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



   .. py:attribute:: ai_building_in_progress
      :value: None



   .. py:attribute:: notification
      :value: None



   .. py:attribute:: whiteboard
      :value: None



   .. py:attribute:: chat_history


   .. py:attribute:: next_ai_building_task


   .. 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:: get()

      Gets a chat session from Data Science Co-pilot.

      :param chat_session_id: Unique ID of the chat session.
      :type chat_session_id: str

      :returns: The chat session with Data Science Co-pilot
      :rtype: ChatSession



   .. py:method:: delete_chat_message(message_index)

      Deletes a message in a chat session and its associated response.

      :param message_index: The index of the chat message within the UI.
      :type message_index: int



   .. py:method:: export()

      Exports a chat session to an HTML file

      :param chat_session_id: Unique ID of the chat session.
      :type chat_session_id: str



   .. py:method:: rename(name)

      Renames a chat session with Data Science Co-pilot.

      :param name: The new name of the chat session.
      :type name: str