abacusai.deployment_conversation ================================ .. py:module:: abacusai.deployment_conversation Classes ------- .. autoapisummary:: abacusai.deployment_conversation.DeploymentConversation Module Contents --------------- .. py:class:: DeploymentConversation(client, deploymentConversationId=None, name=None, deploymentId=None, ownerUserId=None, ownerOrgId=None, createdAt=None, lastEventCreatedAt=None, hasHistory=None, externalSessionId=None, regenerateAttempt=None, externalApplicationId=None, unusedDocumentUploadIds=None, humanizeInstructions=None, conversationWarning=None, conversationType=None, metadata=None, hasAppCheckpoints=None, predictionOverrides=None, llmDisplayName=None, llmBotIcon=None, searchSuggestions=None, chatllmTaskId=None, chatllmProjectId=None, chatllmProjectAccessible=None, verticalType=None, conversationStatus=None, computerStatus=None, filesystemStatus=None, totalEvents=None, firstVisibleEventIndex=None, contestNames=None, daemonTaskId=None, sourceDaemonTaskId=None, daemonTaskRunNumber=None, parentDeploymentConversationId=None, sharedHomeDirectory=None, introMessage=None, previewInfo=None, latestContext=None, shareType=None, isShared=None, isArchived=None, pushNotificationsEnabled=None, platform=None, agentType=None, agentLifecycle=None, orchestratorDeploymentConversationId=None, projectCreditsUsed=None, webAppProjectId=None, personalAgentComputerId=None, scDeployedUrls=None, roleplayCharacter=None, loopType=None, pendingTriggerType=None, nextTriggerCheckTime=None, history={}, hostedArtifacts={}, mobileBuildInfo={}) Bases: :py:obj:`abacusai.return_class.AbstractApiClass` A deployment conversation. :param client: An authenticated API Client instance :type client: ApiClient :param deploymentConversationId: The unique identifier of the deployment conversation. :type deploymentConversationId: str :param name: The name of the deployment conversation. :type name: str :param deploymentId: The deployment id associated with the deployment conversation. :type deploymentId: str :param ownerUserId: The user id of the owner of the deployment conversation. :type ownerUserId: str :param ownerOrgId: The organization id of the owner of the deployment conversation. :type ownerOrgId: str :param createdAt: The timestamp at which the deployment conversation was created. :type createdAt: str :param lastEventCreatedAt: The timestamp at which the most recent corresponding deployment conversation event was created at. :type lastEventCreatedAt: str :param hasHistory: Whether the deployment conversation has any history. :type hasHistory: bool :param externalSessionId: The external session id associated with the deployment conversation. :type externalSessionId: str :param regenerateAttempt: The sequence number of regeneration. Not regenerated if 0. :type regenerateAttempt: int :param externalApplicationId: The external application id associated with the deployment conversation. :type externalApplicationId: str :param unusedDocumentUploadIds: The list of unused document upload ids associated with the deployment conversation. :type unusedDocumentUploadIds: list[str] :param humanizeInstructions: Instructions for humanizing the conversation. :type humanizeInstructions: dict :param conversationWarning: Extra text associated with the deployment conversation (to show it at the bottom of chatbot). :type conversationWarning: str :param conversationType: The type of the conversation, which depicts the application it caters to. :type conversationType: str :param metadata: Additional backend information about the conversation. :type metadata: dict :param hasAppCheckpoints: Whether the conversation may have saved app checkpoints (web app, web server, or mobile app versions, or it ran on the SuperComputer, whose project checkpoints are recorded per-path) — i.e. deleting it can destroy app versions. Set on list responses. :type hasAppCheckpoints: bool :param predictionOverrides: Per-conversation prediction overrides; carries the last-used virtual ChatLLM model's llm_name so the picker/URL can restore it on reopen. :type predictionOverrides: dict :param llmDisplayName: The display name of the LLM model used to generate the most recent response. Only used for system-created bots. :type llmDisplayName: str :param llmBotIcon: The icon location of the LLM model used to generate the most recent response. Only used for system-created bots. :type llmBotIcon: str :param searchSuggestions: The list of search suggestions for the conversation. :type searchSuggestions: list :param chatllmTaskId: The chatllm task id associated with the deployment conversation. :type chatllmTaskId: str :param chatllmProjectId: The chatllm project id associated with the deployment conversation. :type chatllmProjectId: str :param chatllmProjectAccessible: Whether the viewer may open the associated project; false for a conversation shared directly with a viewer who is not part of its project. :type chatllmProjectAccessible: bool :param verticalType: For Expert (vertical) conversations, the owning vertical's type (HEALTH / ROLE_PLAY / LEGAL); null for regular conversations. Lets the unified list mark Expert convos and pick their icon. :type verticalType: str :param conversationStatus: The status of the deployment conversation (used for deep agent conversations). :type conversationStatus: str :param computerStatus: The status of the computer associated with the deployment conversation (used for deep agent conversations). :type computerStatus: str :param filesystemStatus: The status of the filesystem associated with the deployment conversation (used for deep agent conversations). :type filesystemStatus: str :param totalEvents: The total number of events in the deployment conversation. :type totalEvents: int :param firstVisibleEventIndex: The conversation_sequence_number of the first visible event, for FE pagination boundary. :type firstVisibleEventIndex: int :param contestNames: Names of contests that this deployment is a part of. :type contestNames: list[str] :param daemonTaskId: The daemon task id associated with the deployment conversation. :type daemonTaskId: str :param sourceDaemonTaskId: The daemon task created from this conversation (latest with a hosted database when several were), set on task source conversations. :type sourceDaemonTaskId: str :param daemonTaskRunNumber: The 1-based run number of this conversation within its daemon task, set only for conversations holding a single run. :type daemonTaskRunNumber: int :param parentDeploymentConversationId: The parent deployment conversation id associated with the deployment conversation. :type parentDeploymentConversationId: str :param sharedHomeDirectory: Whether this conversation is part of a shared-home-directory group — true if it has a parent conversation or at least one child conversation. :type sharedHomeDirectory: bool :param introMessage: The intro message for the deployment conversation. :type introMessage: str :param previewInfo: App preview info. :type previewInfo: dict :param latestContext: dict containing a list of important segments for pagination in deepagent. :type latestContext: dict :param shareType: The sharing status of the deployment conversation (PUBLIC or PRIVATE). :type shareType: str :param isShared: Whether the owner has an active share on the conversation (org/public tier or any person/group grant). Set on list responses. :type isShared: bool :param isArchived: Whether the owner archived the conversation (hidden from the default lists). :type isArchived: bool :param pushNotificationsEnabled: Whether push notifications are enabled for the deployment conversation. :type pushNotificationsEnabled: bool :param platform: The platform the conversation was created from (WEB, IOS, ANDROID). :type platform: str :param agentType: The type of agent for the deployment conversation (e.g., MASTER_AGENT). :type agentType: str :param agentLifecycle: The lifecycle state of the agent (PENDING, STOPPED, COMPLETED). :type agentLifecycle: str :param orchestratorDeploymentConversationId: The deployment conversation id of the orchestrating master agent, if this conversation is a worker in an agent swarm. :type orchestratorDeploymentConversationId: str :param projectCreditsUsed: The total credits used by all the conversations in the project. :type projectCreditsUsed: int :param webAppProjectId: The web app project id associated with the deployment conversation, if any. :type webAppProjectId: str :param personalAgentComputerId: For SuperComputer conversations, the personal agent computer (VM) this conversation is pinned to, if any. :type personalAgentComputerId: str :param scDeployedUrls: For SuperComputer conversations, the deployed URLs across the conversation's shared-home family (derived at read time; entries carry url and recorded_at). :type scDeployedUrls: list :param roleplayCharacter: For Role Play conversations, the minimal character display (name and image) attached so a viewer who does not own the private character can still see who they're chatting with. :type roleplayCharacter: dict :param loopType: For Media Studio conversations, the dedicated agentic loop the conversation is pinned to (e.g. ad_creation); null when unpinned or not Media Studio. :type loopType: str :param pendingTriggerType: Set while the conversation is paused waiting for a scheduled resume (e.g. TIMED); null once resumed. :type pendingTriggerType: str :param nextTriggerCheckTime: When the scheduler will next resume the paused conversation; null when not paused. :type nextTriggerCheckTime: str :param history: The history of the deployment conversation. :type history: DeploymentConversationEvent :param hostedArtifacts: Artifacts that have been deployed by this conversation. :type hostedArtifacts: HostedArtifact :param mobileBuildInfo: List of mobile app builds with type, build URL, status, and IDs. :type mobileBuildInfo: MobileBuildInfo .. py:attribute:: deployment_conversation_id :value: None .. py:attribute:: name :value: None .. py:attribute:: deployment_id :value: None .. py:attribute:: owner_user_id :value: None .. py:attribute:: owner_org_id :value: None .. py:attribute:: created_at :value: None .. py:attribute:: last_event_created_at :value: None .. py:attribute:: has_history :value: None .. py:attribute:: external_session_id :value: None .. py:attribute:: regenerate_attempt :value: None .. py:attribute:: external_application_id :value: None .. py:attribute:: unused_document_upload_ids :value: None .. py:attribute:: humanize_instructions :value: None .. py:attribute:: conversation_warning :value: None .. py:attribute:: conversation_type :value: None .. py:attribute:: metadata :value: None .. py:attribute:: has_app_checkpoints :value: None .. py:attribute:: prediction_overrides :value: None .. py:attribute:: llm_display_name :value: None .. py:attribute:: llm_bot_icon :value: None .. py:attribute:: search_suggestions :value: None .. py:attribute:: chatllm_task_id :value: None .. py:attribute:: chatllm_project_id :value: None .. py:attribute:: chatllm_project_accessible :value: None .. py:attribute:: vertical_type :value: None .. py:attribute:: conversation_status :value: None .. py:attribute:: computer_status :value: None .. py:attribute:: filesystem_status :value: None .. py:attribute:: total_events :value: None .. py:attribute:: first_visible_event_index :value: None .. py:attribute:: contest_names :value: None .. py:attribute:: daemon_task_id :value: None .. py:attribute:: source_daemon_task_id :value: None .. py:attribute:: daemon_task_run_number :value: None .. py:attribute:: parent_deployment_conversation_id :value: None .. py:attribute:: shared_home_directory :value: None .. py:attribute:: intro_message :value: None .. py:attribute:: preview_info :value: None .. py:attribute:: latest_context :value: None .. py:attribute:: share_type :value: None .. py:attribute:: is_shared :value: None .. py:attribute:: is_archived :value: None .. py:attribute:: push_notifications_enabled :value: None .. py:attribute:: platform :value: None .. py:attribute:: agent_type :value: None .. py:attribute:: agent_lifecycle :value: None .. py:attribute:: orchestrator_deployment_conversation_id :value: None .. py:attribute:: project_credits_used :value: None .. py:attribute:: web_app_project_id :value: None .. py:attribute:: personal_agent_computer_id :value: None .. py:attribute:: sc_deployed_urls :value: None .. py:attribute:: roleplay_character :value: None .. py:attribute:: loop_type :value: None .. py:attribute:: pending_trigger_type :value: None .. py:attribute:: next_trigger_check_time :value: None .. py:attribute:: history .. py:attribute:: hosted_artifacts .. py:attribute:: mobile_build_info .. 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_org_connector_auth() Returns org-level connector auth bound to a deployment conversation. Currently supports Slack only: the org bot token for a SLACK_TAG conversation. :param deployment_conversation_id: The SLACK_TAG deployment conversation id used to resolve Slack context. :type deployment_conversation_id: str :returns: The org-level connector with the authentication details. :rtype: UnifiedConnector .. py:method:: get(external_session_id = None, deployment_id = None, filter_intermediate_conversation_events = True, get_unused_document_uploads = False, start = None, limit = None, include_all_versions = False) Gets a deployment conversation. :param external_session_id: External session ID of the conversation. :type external_session_id: str :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. :type deployment_id: str :param filter_intermediate_conversation_events: If true, intermediate conversation events will be filtered out. Default is true. :type filter_intermediate_conversation_events: bool :param get_unused_document_uploads: If true, unused document uploads will be returned. Default is false. :type get_unused_document_uploads: bool :param start: The start index of the conversation. :type start: int :param limit: The limit of the conversation. :type limit: int :param include_all_versions: If True, includes all versions of the last bot message for version switching functionality. :type include_all_versions: bool :returns: The deployment conversation. :rtype: DeploymentConversation .. py:method:: get_file(file_path) Gets a deployment conversation file. :param file_path: The path of the file to get. :type file_path: str .. py:method:: delete(deployment_id = None) Delete a Deployment Conversation. :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. :type deployment_id: str .. py:method:: clear(external_session_id = None, deployment_id = None, user_message_indices = None) Clear the message history of a Deployment Conversation. :param external_session_id: The external session id associated with the deployment conversation. :type external_session_id: str :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. :type deployment_id: str :param user_message_indices: Optional list of user message indices to clear. The associated bot response will also be cleared. If not provided, all messages will be cleared. :type user_message_indices: list .. py:method:: set_feedback(message_index, is_useful = None, is_not_useful = None, feedback = None, feedback_type = None, deployment_id = None) Sets a deployment conversation message as useful or not useful :param message_index: The index of the deployment conversation message :type message_index: int :param is_useful: If the message is useful. If true, the message is useful. If false, clear the useful flag. :type is_useful: bool :param is_not_useful: If the message is not useful. If true, the message is not useful. If set to false, clear the useful flag. :type is_not_useful: bool :param feedback: Optional feedback on why the message is useful or not useful :type feedback: str :param feedback_type: Optional feedback type :type feedback_type: str :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. :type deployment_id: str .. py:method:: rename(name, deployment_id = None) Rename a Deployment Conversation. :param name: The new name of the conversation. :type name: str :param deployment_id: The deployment this conversation belongs to. This is required if not logged in. :type deployment_id: str .. py:method:: export(external_session_id = None) Export a Deployment Conversation. :param external_session_id: The external session id associated with the deployment conversation. One of deployment_conversation_id or external_session_id must be provided. :type external_session_id: str :returns: The deployment conversation html export. :rtype: DeploymentConversationExport .. py:method:: download_artifacts() Download all artifacts (files/code) for a Deep Agent conversation as a single archive. When the conversation's filesystem is archived, returns a .tar; when available, returns a .zip. Use with the conversation ID of a Deep Agent conversation to download all generated files locally. :param deployment_conversation_id: Unique ID of the Deep Agent conversation whose artifacts to download. :type deployment_conversation_id: str .. py:method:: construct_agent_conversation_messages_for_llm(external_session_id = None, include_document_contents = True) Returns conversation history in a format for LLM calls. :param external_session_id: External session ID of the conversation. :type external_session_id: str :param include_document_contents: If true, include contents from uploaded documents in the generated messages. :type include_document_contents: bool :returns: Contains a list of AgentConversationMessage that represents the conversation. :rtype: AgentConversation