captivate-ai-api 0.5.0

An API for Captivate conversation and state management

Captivate AI & LLM API

Overview

This API is developed by CaptivateChat to handle its API formats.This flexible messaging and metadata management system built using Pydantic models, designed to handle complex communication scenarios with robust type checking and validation.

Key Components

Models

• Captivate: Primary model managing conversation state
• CaptivateResponseModel: Handles response messages and metadata
• ActionModel: Manages actions with flexible payload handling
• ChannelMetadataModel: Stores dynamic channel and conversation metadata

Features

• Dynamic metadata handling
• Immutable session and chat properties
• Flexible message type support
• Custom metadata manipulation
• Conversation title management

You can install through:

pip install captivate-ai-api

Captivate Payload

Here's the JSON payload you will send in the POST request:

{
    "session_id": "lance_catcher_test_69c35e3e-7ff4-484e-8e36-792a62567b79",
    "endpoint": "action",
    "user_input": "hi man",
    "incoming_action": [
        {
            "id": "sendEmail",
            "payload": {
                "email": "[e-mail]",
                "message": "You are fired"
            }
        }
    ],
    "metadata": {
        "internal": {
            "channelMetadata": {
                "course_id": "abc",
                "channelMetadata": {
                    "channel": "custom-channel",
                    "channelData": {}
                },
                "user": {
                    "firstName": "Lance",
                    "lastName": "safa",
                    "email": "[e-mail]"
                },
                "phoneNumber": null,
                "custom": {
                    "mode": "non-dbfred",
                    "title": {
                        "type": "title",
                        "title": "\"Latest Updates on EU Regulations\""
                    }
                }
            }
        }
    },
    "hasLivechat": false
}

Usage Example

from captivate_ai_api import Captivate, TextMessageModel



@app.post("/chat")
async def handle_chat(data: any):
    try:
        # Create Captivate instance using the request data
        captivate = Captivate(**data.dict())
        captivate.set_conversation_title('Lord of the rings')

        # Prepare messages
        response_messages = [
            TextMessageModel(text="Welcome to our platform!"),
            ButtonMessageModel(buttons={"title": "Learn More", "options": [{"label":"Yes","value":"Yes"}]}),
            TableMessageModel(table="<table><tr><th>Name</th><th>Age</th></tr><tr><td>Alice</td><td>30</td></tr></table>"),
            CardCollectionModel(cards=[CardMessageModel(
                text="Special Offer",
                description="Get 20% off your next purchase.",
                image_url="https://example.com/offer.png",
                link="https://example.com/deals"
            )]),
            HtmlMessageModel(html="<h2>Today's Highlights</h2><ul><li>News Item 1</li><li>News Item 2</li></ul>"),
            FileCollectionModel(files=[FileModel(type='application/pdf',url="https://example.com/manual.pdf", filename="UserManual.pdf")] ),
            {"type": "custom", "content": "This is a custom message."}
        ]
        
        # Set the response messages
        captivate.set_response(response_messages)

        # Outgoing actions Both 'payload' & 'data' works for backwards compatibliity. Moving forward it is recommended to use 'data'
        outgoing_actions = [
            ActionModel(id="navigate", payload={"url": "https://example.com"}),
            ActionModel(id="submit", data={"form_id": "1234"})
        ] 
        captivate.set_outgoing_action(outgoing_actions)

        return captivate.get_response() #Returns data to captivate platform in the correct format

Expected Response from /chat Endpoint

When you send the POST request to the /chat endpoint, the response will look as follows:

{
    "response": [
        {
            "type": "text",
            "text": "Welcome to our platform!"
        },
        {
            "type": "button",
            "buttons": {
                "title": "Learn More",
                "options": {
                    "label":"Yes",
                    "value":"Yes"
                }
            }
        },
        {
            "type": "table",
            "table": "<table><tr><th>Name</th><th>Age</th></tr><tr><td>Alice</td><td>30</td></tr></table>"
        },
        {
            "type": "cards",
            "text": "Special Offer",
            "description": "Get 20% off your next purchase.",
            "image_url": "https://example.com/offer.png",
            "link": "https://example.com/deals"
        },
        {
            "type": "html",
            "html": "<h2>Today's Highlights</h2><ul><li>News Item 1</li><li>News Item 2</li></ul>"
        },
        { 
        "type":"files",
        "title":"these are the files",
        "files":[{
            "type": "application/pdf",
            "url": "https://example.com/manual.pdf",
            "filename": "UserManual.pdf"
            }]
        },
        {
            "type": "alert",
            "RootModel": {
                "priority": "high",
                "message": "System maintenance scheduled."
            }
        }
    ],
    "session_id": "lance_catcher_test_69c35e3e-7ff4-484e-8e36-792a62567b79",
    "metadata": {
        "internal": {
            "channelMetadata": {
                "user": {
                    "firstName": "Lance",
                    "lastName": "safa",
                    "email": "[e-mail]"
                },
                "channelMetadata": {
                    "channel": "custom-channel",
                    "channelData": {}
                },
                "custom": {
                    "mode": "non-dbfred",
                    "title": {
                        "type": "title",
                        "title": "Lord of the rings"
                    }
                },
                "conversationCreatedAt": null,
                "conversationUpdatedAt": null
            }
        }
    },
    "outgoing_action": [
        {
            "id": "navigate",
            "payload": {
                "url": "https://example.com"
            },
            "data": {
                "url": "https://example.com"
            }
        },
        {
            "id": "submit",
            "payload": {
                "form_id": "1234"
            },
            "data": {
                "form_id": "1234"
            }
        }
    ],
    "hasLivechat": false
}

Functions Overview

1. get_session_id

def get_session_id(self) -> str:

• Description: Returns the value of session_id.
• Example:

session_id = captivate_instance.get_session_id()

2. get_user_input

def get_user_input(self) -> Optional[str]:

• Description: Returns the value of user_input.
• Example:

user_input = captivate_instance.get_user_input()

3. set_conversation_title

def set_conversation_title(self, title: str):

• Description: Sets the conversation title in the custom metadata.
• Example:

captivate_instance.set_conversation_title("New Conversation Title")

4. get_conversation_title

def get_conversation_title(self) -> Optional[str]:

• Description: Retrieves the conversation title from the custom metadata.
• Example:

conversation_title = captivate_instance.get_conversation_title()

5. set_metadata

def set_metadata(self, key: str, value: Any):

• Description: Sets a key-value pair in the custom metadata.
• Example:

captivate_instance.set_metadata("custom_key", "custom_value")

6. get_metadata

def get_metadata(self, key: str) -> Optional[Any]:

• Description: Retrieves the value for a given key in the custom metadata.
• Example:

metadata_value = captivate_instance.get_metadata("custom_key")

7. remove_metadata

def remove_metadata(self, key: str) -> bool:

• Description: Removes a key from the custom metadata.
• Example:

captivate_instance.remove_metadata("custom_key")

8. get_channel

def get_channel(self) -> Optional[str]:

• Description: Retrieves the channel from the metadata.
• Example:

channel = captivate_instance.get_channel()

9. get_user

def get_user(self) -> Optional[UserModel]:

• Description: Retrieves the user from the metadata.
• Example:

user = captivate_instance.get_user()

10. set_user

def set_user(self, user: UserModel) -> None:

• Description: Sets the user in the metadata.
• Example:

captivate_instance.set_user(UserModel(firstName="John", lastName="Doe"))

11. get_created_at

def get_created_at(self) -> Optional[str]:

• Description: Returns the conversationCreatedAt timestamp from the metadata.
• Example:

created_at = captivate_instance.get_created_at()

12. get_updated_at

def get_updated_at(self) -> Optional[str]:

• Description: Returns the conversationUpdatedAt timestamp from the metadata.
• Example:

updated_at = captivate_instance.get_updated_at()

13. get_has_livechat

def get_has_livechat(self) -> bool:

• Description: Returns the value of hasLivechat.
• Example:

has_livechat = captivate_instance.get_has_livechat()

14. set_response

def set_response(self, response: List[Union[TextMessageModel, FileCollectionModel, ButtonMessageModel, TableMessageModel, CardCollectionModel, HtmlMessageModel, dict]]) -> None:

• Description: Sets the response messages in the Captivate instance.
• Example:

captivate_instance.set_response([
            TextMessageModel(text="Welcome to our platform!"),
            ButtonMessageModel(buttons={"title": "Learn More", "action": "navigate"}),
            TableMessageModel(table="<table><tr><th>Name</th><th>Age</th></tr><tr><td>Alice</td><td>30</td></tr></table>"),
            CardCollectionModel(cards=[CardMessageModel(
                text="Special Offer",
                description="Get 20% off your next purchase.",
                image_url="https://example.com/offer.png",
                link="https://example.com/deals"
            )]),
            HtmlMessageModel(html="<h2>Today's Highlights</h2><ul><li>News Item 1</li><li>News Item 2</li></ul>"),
           FileCollectionModel(title="See files below", files=[FileModel(type='application/pdf',url="https://example.com/manual.pdf", filename="UserManual.pdf")] ),
            {"type": "custom", "content": "This is a custom message."}
            ])

15. get_incoming_action

def get_incoming_action(self) -> Optional[List[ActionModel]]:

• Description: Retrieves the incoming actions from the response object, if present.
• Example:

incoming_actions = captivate_instance.get_incoming_action()

16. set_outgoing_action

def set_outgoing_action(self, actions: List[ActionModel]) -> None:

• Description: Sets the outgoing actions in the response object.
• Example:

captivate_instance.set_outgoing_action([
    ActionModel(id="navigate", data={"url": "https://example.com"})
])

17. get_response

def get_response(self) -> Optional[str]:

• Description: Returns the CaptivateResponseModel as a JSON string if it exists, otherwise returns None.
• Example:

response_json = captivate_instance.get_response()

18. async_send_message

async def async_send_message(self, environment: str = "dev") -> Dict[str, Any]:

• Description: The async_send_message method is an asynchronous function that sends the conversation data (including messages and actions) to the captivate async messsage API endpoint, depending on the environment (dev or prod)
• Example:

# Create an instance of Captivate
captivate = Captivate(session_id="12345", hasLivechat=True, metadata=metadata)

# Set a message and actions
captivate.set_response([TextMessageModel(text="Hello, World!")])

# Send the message to the API in 'dev' environment
response = await captivate.async_send_message(environment="dev")

18. download_file_to_memory

 async def download_file_to_memory(self, file_info: Dict[str, Any]) -> io.BytesIO:

• Description: Downloads a file from the given dictionary and stores it in memory.

• Example:

captivate_instance.download_file_to_memory(file_info)

19. escalate_to_human

def escalate_to_human(self) -> None:

• Description: Sets an outgoing action to escalate the conversation to a human agent.
• Example:

captivate_instance.escalate_to_human()

20. escalate_to_agent_router

def escalate_to_agent_router(self, reason: Optional[str] = None, intent: Optional[str] = None, recommended_agents: Optional[List[str]] = None) -> None:

• Description: Sets an outgoing action to escalate the conversation to an agent router with optional payload data.
• Parameters:
  • reason (str, optional): The reason for escalation
  • intent (str, optional): The user's intent
  • recommended_agents (List[str], optional): Array of agent IDs to recommend
• Example:

# Basic escalation without payload
captivate_instance.escalate_to_agent_router()

# Escalation with all parameters
captivate_instance.escalate_to_agent_router(
    reason="Complex billing inquiry",
    intent="resolve_payment_issue", 
    recommended_agents=["agent_123", "agent_456", "agent_789"]
)

21. Router Mode Management

The Captivate class includes router mode functionality that controls access to certain methods using a decorator pattern.

21.1 enable_router_mode

def enable_router_mode(self) -> None:

• Description: Enables router mode which allows access to protected methods.
• Example:

captivate_instance.enable_router_mode()

21.2 disable_router_mode

def disable_router_mode(self) -> None:

• Description: Disables router mode, preventing access to protected methods.
• Example:

captivate_instance.disable_router_mode()

21.3 is_router_mode

def is_router_mode(self) -> bool:

• Description: Checks if router mode is currently enabled.
• Returns: bool - True if router mode is enabled, False otherwise
• Example:

if captivate_instance.is_router_mode():
    print("Router mode is enabled")

22. Protected Methods (Router Mode Required)

The following methods are protected by the @requires_router_mode decorator and can only be accessed when router mode is enabled:

22.1 set_agents

@requires_router_mode
def set_agents(self, agents_list: List[str]) -> None:

• Description: Sets the agents_list in custom metadata. This can only be set once and requires router mode to be enabled.
• Parameters:
  • agents_list (List[str]): List of agent IDs to set as agents_list
• Example:

# Enable router mode first
captivate_instance.enable_router_mode()

# Set agents list
captivate_instance.set_agents(["agent_001", "agent_002", "agent_003"])

22.2 get_outgoing_action

@requires_router_mode
def get_outgoing_action(self) -> Optional[List[ActionModel]]:

• Description: Retrieves the outgoing actions from the response object. Only available when router mode is enabled.
• Returns: Optional[List[ActionModel]] - List of outgoing actions or None
• Example:

# Enable router mode first
captivate_instance.enable_router_mode()

# Get outgoing actions
outgoing_actions = captivate_instance.get_outgoing_action()

22.3 is_escalating_to_agent_router

@requires_router_mode
def is_escalating_to_agent_router(self) -> Optional[Dict[str, Any]]:

• Description: Checks if the outgoing action is escalating to agent router and returns the payload. Only available when router mode is enabled.
• Returns: Optional[Dict[str, Any]] - The payload if escalating to agent router, None otherwise
• Example:

# Enable router mode first
captivate_instance.enable_router_mode()

# Check if escalating to agent router
payload = captivate_instance.is_escalating_to_agent_router()
if payload:
    print(f"Escalating with payload: {payload}")

23. Router Mode Usage Examples

Complete Router Mode Workflow

# 1. Create Captivate instance
captivate_instance = Captivate(**data)

# 2. Router mode is disabled by default
print(captivate_instance.is_router_mode())  # False

# 3. Protected methods will fail when router mode is disabled
try:
    captivate_instance.set_agents(["agent_001"])
except ValueError as e:
    print(e)  # "set_agents is only available when router mode is enabled."

# 4. Enable router mode
captivate_instance.enable_router_mode()
print(captivate_instance.is_router_mode())  # True

# 5. Now protected methods work
captivate_instance.set_agents(["agent_001", "agent_002"])
agents = captivate_instance.get_agents()  # ["agent_001", "agent_002"]

# 6. Set up escalation
captivate_instance.escalate_to_agent_router(
    reason="Technical issue",
    recommended_agents=["agent_001"]
)

# 7. Check escalation status
payload = captivate_instance.is_escalating_to_agent_router()
print(payload)  # {"reason": "Technical issue", "recommended_agents": ["agent_001"]}

# 8. Disable router mode
captivate_instance.disable_router_mode()

# 9. Protected methods fail again
try:
    captivate_instance.get_outgoing_action()
except ValueError as e:
    print(e)  # "get_outgoing_action is only available when router mode is enabled."

Error Handling

# All protected methods throw consistent errors when router mode is disabled
try:
    captivate_instance.set_agents(["agent_001"])
except ValueError as e:
    print(e)  # "set_agents is only available when router mode is enabled."

try:
    captivate_instance.get_outgoing_action()
except ValueError as e:
    print(e)  # "get_outgoing_action is only available when router mode is enabled."

try:
    captivate_instance.is_escalating_to_agent_router()
except ValueError as e:
    print(e)  # "is_escalating_to_agent_router is only available when router mode is enabled."

24. Decorator Pattern Implementation

The router mode functionality uses a decorator pattern for clean, maintainable code:

def requires_router_mode(func):
    """Decorator to ensure router mode is enabled for specific methods."""
    @wraps(func)
    def wrapper(self, *args, **kwargs):
        if not self._router_mode:
            raise ValueError(f"{func.__name__} is only available when router mode is enabled.")
        return func(self, *args, **kwargs)
    return wrapper

Benefits of the decorator pattern:

• DRY Principle: Single decorator handles all router mode checks
• Clean Code: Methods focus on core logic, validation is automatic
• Easy to Extend: Add @requires_router_mode to any new method
• Consistent Errors: Same error format across all protected methods

21. escalate_to_agent

def escalate_to_agent(self, agent_id: str, reason: Optional[str] = None) -> None:

• Description: Sets an outgoing action to force redirect the conversation to a specific agent.
• Parameters:
  • agent_id (str): The ID of the agent to redirect to
  • reason (str, optional): The reason for the force redirection
• Example:

# Force redirect to a specific agent without reason
captivate_instance.escalate_to_agent("agent_123")

# Force redirect to a specific agent with reason
captivate_instance.escalate_to_agent(
    agent_id="billing_specialist_001", 
    reason="User has complex billing inquiry requiring specialist knowledge"
)

22. set_private_metadata and Private Metadata Usage

def set_private_metadata(self, key: str, value: Any) -> None:

• Description:
  Sets a key-value pair in the private metadata section (custom['private']) of the conversation. This data is for internal use and is not exposed to the end user.
  You can retrieve this value using get_metadata(key).

• Example:

captivate_instance = Captivate(**data_action)

# Set a private metadata key-value pair
captivate_instance.set_private_metadata('my_secret', 123)

# Retrieve the private metadata value
print(captivate_instance.get_metadata('my_secret'))  # Output: 123

Reserved Key Protection

Attempting to set reserved keys like "private", "title", or "conversation_title" in metadata will raise an exception:

try:
    captivate_instance.set_metadata('private', 'should fail')
except Exception as e:
    print('Expected error for reserved key:', e)