Skip to content

Schema

The Conversation / Message / Detection schema is the core contract of the library. Every adapter produces conversations matching this schema; every detector consumes conversations and emits detections.

Role

Bases: StrEnum

Who sent a given message.

FailureMode

Bases: StrEnum

The 7 chatbot failure modes this library detects.

Severity

Bases: StrEnum

How bad is the detected failure.

Message

Bases: BaseModel

A single message in a conversation.

Conversation

Bases: BaseModel

A full chatbot conversation with one or more messages.

duration property

duration: timedelta | None

Time from first to last message, if timestamps are available.

message_count property

message_count: int

Total number of messages.

user_messages property

user_messages: list[Message]

Messages from the end user.

bot_messages property

bot_messages: list[Message]

Messages from the chatbot.

agent_messages property

agent_messages: list[Message]

Messages from a human agent.

Evidence

Bases: BaseModel

A specific piece of evidence supporting a detection.

Detection

Bases: BaseModel

A single detected failure in a conversation.