Compare commits

..
73 changed files with 242 additions and 2409 deletions
+1 -1
View File
@@ -195,7 +195,7 @@ gem 'reverse_markdown'
gem 'iso-639'
gem 'ruby-openai'
gem 'ai-agents', '>= 0.12.0'
gem 'ai-agents', '>= 0.10.0'
# TODO: Move this gem as a dependency of ai-agents
gem 'ruby_llm', '>= 1.14.1'
+4 -4
View File
@@ -126,7 +126,7 @@ GEM
jbuilder (~> 2)
rails (>= 4.2, < 7.2)
selectize-rails (~> 0.6)
ai-agents (0.12.0)
ai-agents (0.10.0)
ruby_llm (~> 1.14)
annotaterb (4.20.0)
activerecord (>= 6.0.0)
@@ -198,7 +198,7 @@ GEM
crack (1.0.0)
bigdecimal
rexml
crass (1.0.7)
crass (1.0.6)
cronex (0.15.0)
tzinfo
unicode (>= 0.4.4.5)
@@ -570,7 +570,7 @@ GEM
minitest (5.25.5)
mock_redis (0.36.0)
ruby2_keywords
msgpack (1.8.3)
msgpack (1.8.0)
multi_json (1.15.0)
multi_xml (0.9.1)
bigdecimal (>= 3.1, < 5)
@@ -1058,7 +1058,7 @@ DEPENDENCIES
administrate (>= 0.20.1)
administrate-field-active_storage (>= 1.0.3)
administrate-field-belongs_to_search (>= 0.9.0)
ai-agents (>= 0.12.0)
ai-agents (>= 0.10.0)
annotaterb
attr_extras
audited (~> 5.4, >= 5.4.1)
@@ -1,5 +1,6 @@
class Api::V1::Accounts::Conversations::MessagesController < Api::V1::Accounts::Conversations::BaseController
before_action :ensure_api_inbox, only: :update
before_action :ensure_agent_bot_takeover, only: :create
def index
@messages = message_finder.perform
@@ -52,9 +53,6 @@ class Api::V1::Accounts::Conversations::MessagesController < Api::V1::Accounts::
end
render json: { content: translated_content }
rescue Google::Cloud::Error => e
# `details` carries the clean human message; `message` includes gRPC debug noise
render_could_not_create_error(e.details.presence || e.message)
end
private
@@ -75,6 +73,21 @@ class Api::V1::Accounts::Conversations::MessagesController < Api::V1::Accounts::
message.translations.present? && message.translations[permitted_params[:target_language]].present?
end
def ensure_agent_bot_takeover
return unless Current.user.is_a?(User) && @conversation.assignee_agent_bot_id.present?
return if private_message? || incoming_message?
render json: { error: 'Conversation is assigned to an Agent Bot. Take over the conversation before replying.' }, status: :unprocessable_entity
end
def private_message?
ActiveModel::Type::Boolean.new.cast(params[:private])
end
def incoming_message?
params[:message_type] == 'incoming'
end
# API inbox check
def ensure_api_inbox
# Only API inboxes can update messages
@@ -1,10 +1,6 @@
/* global axios */
import ApiClient from '../ApiClient';
// Viewer's UTC offset in hours, matching the reports API convention so the
// backend can anchor calendar ranges to the viewer's day.
const getTimezoneOffset = () => -new Date().getTimezoneOffset() / 60;
class CaptainAssistant extends ApiClient {
constructor() {
super('captain/assistants', { accountScoped: true });
@@ -25,18 +21,6 @@ class CaptainAssistant extends ApiClient {
message_history: messageHistory,
});
}
getStats({ assistantId, range }) {
return axios.get(`${this.url}/${assistantId}/stats`, {
params: { range, timezone_offset: getTimezoneOffset() },
});
}
getSummary({ assistantId, range }) {
return axios.get(`${this.url}/${assistantId}/summary`, {
params: { range, timezone_offset: getTimezoneOffset() },
});
}
}
export default new CaptainAssistant();
@@ -182,8 +182,7 @@ const handleCreateAssistant = () => {
</div>
</div>
<div class="flex items-center gap-2">
<slot name="headerActions" />
<div class="flex gap-2">
<slot name="search" />
<div
v-if="!showPaywall && buttonLabel"
@@ -29,6 +29,7 @@ const initialState = {
handoffMessage: '',
resolutionMessage: '',
instructions: '',
temperature: 1,
};
const state = reactive({ ...initialState });
@@ -56,6 +57,7 @@ const updateStateFromAssistant = assistant => {
state.handoffMessage = config.handoff_message;
state.resolutionMessage = config.resolution_message;
state.instructions = config.instructions;
state.temperature = config.temperature || 1;
};
const handleSystemMessagesUpdate = async () => {
@@ -78,6 +80,7 @@ const handleSystemMessagesUpdate = async () => {
...props.assistant.config,
handoff_message: state.handoffMessage,
resolution_message: state.resolutionMessage,
temperature: state.temperature || 1,
},
};
@@ -128,6 +131,26 @@ watch(
class="z-0"
/>
<div class="flex flex-col gap-2">
<label class="text-sm font-medium text-n-slate-12">
{{ t('CAPTAIN.ASSISTANTS.FORM.TEMPERATURE.LABEL') }}
</label>
<div class="flex items-center gap-4">
<input
v-model="state.temperature"
type="range"
min="0"
max="1"
step="0.1"
class="w-full"
/>
<span class="text-sm text-n-slate-12">{{ state.temperature }}</span>
</div>
<p class="text-sm text-n-slate-11 italic">
{{ t('CAPTAIN.ASSISTANTS.FORM.TEMPERATURE.DESCRIPTION') }}
</p>
</div>
<div>
<Button
:label="t('CAPTAIN.ASSISTANTS.FORM.UPDATE')"
@@ -1,88 +0,0 @@
<script setup>
import { computed, ref } from 'vue';
import { useRoute, useRouter } from 'vue-router';
import { LocalStorage } from 'shared/helpers/localStorage';
const props = defineProps({
knowledge: {
type: Object,
default: () => ({ approved: 0, pending: 0, documents: 0, coverage: 0 }),
},
});
const route = useRoute();
const router = useRouter();
// Dismissal is remembered per assistant for 24 hours (setFlag's default expiry).
const DISMISS_STORE = 'captain_overview_coverage_banner';
const accountId = computed(() => route.params.accountId);
const assistantId = computed(() => route.params.assistantId);
const dismissed = ref(
LocalStorage.getFlag(DISMISS_STORE, accountId.value, assistantId.value)
);
// Thin coverage paired with a large review backlog: approving the pending FAQs
// is the quickest lever to lift auto-resolution, so nudge the team to act.
const COVERAGE_THRESHOLD = 85;
const PENDING_THRESHOLD = 100;
const showBanner = computed(
() =>
!dismissed.value &&
(props.knowledge?.coverage ?? 0) < COVERAGE_THRESHOLD &&
(props.knowledge?.pending ?? 0) > PENDING_THRESHOLD
);
const dismiss = () => {
LocalStorage.setFlag(DISMISS_STORE, accountId.value, assistantId.value);
dismissed.value = true;
};
const goToPending = () => {
router.push({
name: 'captain_assistants_responses_pending',
params: {
accountId: route.params.accountId,
assistantId: route.params.assistantId,
},
});
};
</script>
<template>
<div
v-if="showBanner"
class="flex items-center justify-between gap-3 px-3 py-2 text-sm border rounded-xl bg-n-amber-3 border-n-amber-4 text-n-amber-11"
>
<div class="flex items-center gap-2 min-w-0">
<span class="shrink-0 i-lucide-triangle-alert size-4" />
<span class="truncate">
{{
$t('CAPTAIN.OVERVIEW.COVERAGE_BANNER.TEXT', {
count: knowledge.pending,
coverage: knowledge.coverage,
})
}}
</span>
</div>
<div class="flex items-center gap-1 shrink-0">
<button
type="button"
class="px-3 py-1 rounded-lg bg-n-amber-4 hover:bg-n-amber-5"
@click="goToPending"
>
{{ $t('CAPTAIN.OVERVIEW.COVERAGE_BANNER.ACTION') }}
</button>
<button
type="button"
class="grid rounded-lg size-7 place-content-center hover:bg-n-amber-4"
:aria-label="$t('CAPTAIN.OVERVIEW.COVERAGE_BANNER.DISMISS')"
@click="dismiss"
>
<span class="i-lucide-x size-4" />
</button>
</div>
</div>
</template>
@@ -1,79 +0,0 @@
<script setup>
import { computed } from 'vue';
defineProps({
// Selected day-range, used only for the chart's start-axis label.
range: { type: String, default: '30' },
});
// Daily assistant credit usage (sample data) rendered as a lightweight bar
// chart, so we avoid pulling in a chart library for placeholder visuals.
const creditUsage = {
total: '48,210',
trend: '+18.2%',
daily: [
120, 145, 132, 160, 175, 158, 190, 210, 195, 230, 220, 245, 260, 240, 275,
290, 270, 310, 295, 330, 350, 325, 360, 380, 355, 400, 420, 395, 440, 465,
],
};
// Bar heights as a percentage of the peak day, with a small floor so even the
// lowest day stays visible.
const bars = computed(() => {
const max = Math.max(...creditUsage.daily);
return creditUsage.daily.map((value, index) => ({
key: index,
value,
height: Math.max(6, Math.round((value / max) * 100)),
}));
});
</script>
<template>
<section class="flex flex-col gap-4">
<div class="flex items-start justify-between gap-4">
<div class="flex flex-col gap-1">
<h3 class="text-base font-medium text-n-slate-12">
{{ $t('CAPTAIN.OVERVIEW.CREDITS.TITLE') }}
</h3>
<div class="flex items-baseline gap-2">
<span class="text-2xl font-semibold tabular-nums text-n-slate-12">
{{ creditUsage.total }}
</span>
<span class="text-sm text-n-slate-11">
{{ $t('CAPTAIN.OVERVIEW.CREDITS.UNIT') }}
</span>
<span class="text-sm font-medium tabular-nums text-n-slate-11">
{{ creditUsage.trend }}
</span>
</div>
</div>
<div class="flex items-center gap-2 mt-1">
<span class="rounded-full size-2.5 bg-n-brand" />
<span class="text-xs text-n-slate-11">
{{ $t('CAPTAIN.OVERVIEW.CREDITS.LEGEND') }}
</span>
</div>
</div>
<div class="p-5 border rounded-xl bg-n-solid-1 border-n-weak">
<div class="flex items-end gap-1 h-40">
<div
v-for="bar in bars"
:key="bar.key"
v-tooltip="`${bar.value} ${$t('CAPTAIN.OVERVIEW.CREDITS.UNIT')}`"
class="flex-1 rounded-t transition-colors bg-n-brand/70 hover:bg-n-brand"
:style="{ height: `${bar.height}%` }"
/>
</div>
<div class="flex items-center justify-between mt-3">
<span class="text-xs text-n-slate-10">
{{ $t('CAPTAIN.OVERVIEW.CREDITS.AXIS_START', { count: range }) }}
</span>
<span class="text-xs text-n-slate-10">
{{ $t('CAPTAIN.OVERVIEW.CREDITS.AXIS_END') }}
</span>
</div>
</div>
</section>
</template>
@@ -1,73 +0,0 @@
<script setup>
import { computed, ref, watch } from 'vue';
import { useRoute, useRouter } from 'vue-router';
import { useStore, useMapGetter } from 'dashboard/composables/store';
const route = useRoute();
const router = useRouter();
const store = useStore();
const dismissed = ref(false);
const assistantId = computed(() => route.params.assistantId);
const inboxes = useMapGetter('captainInboxes/getRecords');
const uiFlags = useMapGetter('captainInboxes/getUIFlags');
// Only surface once we know the assistant has no connected inboxes.
const showBanner = computed(
() =>
!dismissed.value &&
!uiFlags.value.fetchingList &&
inboxes.value.length === 0
);
watch(
assistantId,
id => {
dismissed.value = false;
if (id) store.dispatch('captainInboxes/get', { assistantId: id });
},
{ immediate: true }
);
const goToInboxes = () => {
router.push({
name: 'captain_assistants_inboxes_index',
params: {
accountId: route.params.accountId,
assistantId: assistantId.value,
},
});
};
</script>
<template>
<div
v-if="showBanner"
class="flex items-center justify-between gap-3 px-3 py-2 text-sm border rounded-xl bg-n-amber-3 border-n-amber-4 text-n-amber-11"
>
<div class="flex items-center gap-2 min-w-0">
<span class="shrink-0 i-lucide-triangle-alert size-4" />
<span class="truncate">
{{ $t('CAPTAIN.OVERVIEW.INBOX_BANNER.TEXT') }}
</span>
</div>
<div class="flex items-center gap-1 shrink-0">
<button
type="button"
class="px-3 py-1 rounded-lg bg-n-amber-4 hover:bg-n-amber-5"
@click="goToInboxes"
>
{{ $t('CAPTAIN.OVERVIEW.INBOX_BANNER.ACTION') }}
</button>
<button
type="button"
class="grid rounded-lg size-7 place-content-center hover:bg-n-amber-4"
:aria-label="$t('CAPTAIN.OVERVIEW.INBOX_BANNER.DISMISS')"
@click="dismissed = true"
>
<span class="i-lucide-x size-4" />
</button>
</div>
</div>
</template>
@@ -1,87 +0,0 @@
<script setup>
import { computed } from 'vue';
import { useRoute } from 'vue-router';
import { useI18n } from 'vue-i18n';
const props = defineProps({
knowledge: {
type: Object,
default: () => ({ approved: 0, pending: 0, documents: 0, coverage: 0 }),
},
});
const { t } = useI18n();
const route = useRoute();
const approvedPct = computed(() => props.knowledge.coverage ?? 0);
const linkTo = routeName => ({
name: routeName,
params: {
accountId: route.params.accountId,
assistantId: route.params.assistantId,
},
});
const stats = computed(() => [
{
key: 'approved',
value: props.knowledge.approved,
label: t('CAPTAIN.OVERVIEW.KNOWLEDGE.APPROVED'),
to: linkTo('captain_assistants_responses_index'),
},
{
key: 'pending',
value: props.knowledge.pending,
label: t('CAPTAIN.OVERVIEW.KNOWLEDGE.PENDING'),
to: linkTo('captain_assistants_responses_pending'),
},
{
key: 'documents',
value: props.knowledge.documents,
label: t('CAPTAIN.OVERVIEW.KNOWLEDGE.DOCUMENTS'),
to: linkTo('captain_assistants_documents_index'),
},
]);
</script>
<template>
<div
class="flex flex-col gap-4 p-5 border rounded-xl bg-n-solid-1 border-n-weak"
>
<div class="flex items-center justify-between">
<span class="text-sm font-medium text-n-slate-12">
{{ $t('CAPTAIN.OVERVIEW.KNOWLEDGE.TITLE') }}
</span>
<span class="text-sm tabular-nums text-n-slate-11">
{{ $t('CAPTAIN.OVERVIEW.KNOWLEDGE.COVERAGE', { pct: approvedPct }) }}
</span>
</div>
<div class="w-full h-2 overflow-hidden rounded-full bg-n-alpha-2">
<div
class="h-full rounded-full bg-n-brand"
:style="{ width: `${approvedPct}%` }"
/>
</div>
<div class="grid grid-cols-3 gap-3">
<RouterLink
v-for="stat in stats"
:key="stat.key"
:to="stat.to"
class="flex flex-col gap-1 group/stat"
>
<span class="text-xl font-semibold tabular-nums text-n-slate-12">
{{ stat.value }}
</span>
<span
class="inline-flex items-center gap-1 text-xs transition-colors text-n-slate-11 group-hover/stat:text-n-slate-12"
>
{{ stat.label }}
<span
class="transition-opacity opacity-0 i-lucide-arrow-up-right size-3 group-hover/stat:opacity-100"
/>
</span>
</RouterLink>
</div>
</div>
</template>
@@ -1,40 +0,0 @@
<script setup>
import { computed } from 'vue';
const props = defineProps({
label: { type: String, required: true },
value: { type: String, required: true },
trend: { type: String, default: '' },
hint: { type: String, default: '' },
// null = neutral, true = good direction, false = bad direction
trendGood: { type: Boolean, default: null },
});
const trendClass = computed(() => {
if (props.trendGood === null) return 'text-n-slate-11';
return props.trendGood ? 'text-n-teal-11' : 'text-n-ruby-11';
});
</script>
<template>
<div class="flex flex-col gap-3 p-5 group bg-n-solid-1">
<div class="flex items-center gap-1.5">
<span class="text-sm font-medium text-n-slate-11">{{ label }}</span>
<span
v-if="hint"
v-tooltip="hint"
class="transition-opacity opacity-0 cursor-help i-lucide-info size-3.5 text-n-slate-10 group-hover:opacity-100"
/>
</div>
<div class="flex items-end justify-between gap-2">
<span
class="text-3xl font-semibold tracking-tight tabular-nums text-n-slate-12"
>
{{ value }}
</span>
<span class="text-sm font-medium tabular-nums" :class="trendClass">
{{ trend }}
</span>
</div>
</div>
</template>
@@ -1,81 +0,0 @@
<script setup>
import { computed } from 'vue';
import { useRoute, RouterLink } from 'vue-router';
import { useI18n } from 'vue-i18n';
import { useAccount } from 'dashboard/composables/useAccount';
import { getHelpUrlForFeature } from 'dashboard/helper/featureHelper';
const { t } = useI18n();
const route = useRoute();
const { isOnChatwootCloud } = useAccount();
const assistantParams = computed(() => ({
accountId: route.params.accountId,
assistantId: route.params.assistantId,
}));
const links = computed(() => [
{
key: 'docs',
title: t('CAPTAIN.OVERVIEW.LINKS.DOCS.TITLE'),
description: t('CAPTAIN.OVERVIEW.LINKS.DOCS.DESCRIPTION'),
icon: 'i-lucide-book-open',
href: getHelpUrlForFeature('captain'),
},
{
key: 'playground',
title: t('CAPTAIN.OVERVIEW.LINKS.PLAYGROUND.TITLE'),
description: t('CAPTAIN.OVERVIEW.LINKS.PLAYGROUND.DESCRIPTION'),
icon: 'i-lucide-flask-conical',
to: {
name: 'captain_assistants_playground_index',
params: assistantParams.value,
},
},
{
key: 'billing',
title: t('CAPTAIN.OVERVIEW.LINKS.BILLING.TITLE'),
description: t('CAPTAIN.OVERVIEW.LINKS.BILLING.DESCRIPTION'),
icon: 'i-lucide-credit-card',
to: {
name: 'billing_settings_index',
params: { accountId: route.params.accountId },
},
},
]);
</script>
<template>
<div v-if="isOnChatwootCloud" class="grid grid-cols-1 gap-4 sm:grid-cols-3">
<component
:is="link.href ? 'a' : RouterLink"
v-for="link in links"
:key="link.key"
:href="link.href"
:to="link.to"
:target="link.href ? '_blank' : undefined"
:rel="link.href ? 'noopener noreferrer' : undefined"
class="flex items-center gap-3 p-4 transition-colors border rounded-xl bg-n-solid-1 border-n-weak hover:bg-n-alpha-1 group/link"
>
<span
class="grid rounded-lg size-9 shrink-0 place-content-center bg-n-alpha-2 text-n-slate-11"
>
<span :class="link.icon" class="size-4" />
</span>
<div class="flex flex-col min-w-0">
<span class="text-sm font-medium text-n-slate-12">
{{ link.title }}
</span>
<span class="text-xs truncate text-n-slate-11">
{{ link.description }}
</span>
</div>
<span
:class="
link.href ? 'i-lucide-arrow-up-right' : 'i-lucide-chevron-right'
"
class="ml-auto transition-opacity opacity-0 size-4 text-n-slate-10 group-hover/link:opacity-100"
/>
</component>
</div>
</template>
@@ -1,79 +0,0 @@
<script setup>
import { computed } from 'vue';
import { useToggle } from '@vueuse/core';
import { useI18n } from 'vue-i18n';
import { vOnClickOutside } from '@vueuse/components';
import Button from 'dashboard/components-next/button/Button.vue';
import DropdownMenu from 'dashboard/components-next/dropdown-menu/DropdownMenu.vue';
const modelValue = defineModel({ type: String, default: '30' });
const { t } = useI18n();
const [showDropdown, toggleDropdown] = useToggle();
const DAY_RANGES = ['7', '30', '90'];
const decorate = item => ({
...item,
action: 'select',
isSelected: item.value === modelValue.value,
});
const menuSections = computed(() => {
const dayItems = DAY_RANGES.map(value =>
decorate({
value,
label: t('CAPTAIN.OVERVIEW.RANGES.LAST_DAYS', { count: value }),
})
);
const monthItems = [
decorate({
value: 'this_month',
label: t('CAPTAIN.OVERVIEW.RANGES.THIS_MONTH'),
}),
decorate({
value: 'last_month',
label: t('CAPTAIN.OVERVIEW.RANGES.LAST_MONTH'),
}),
];
return [{ items: dayItems }, { items: monthItems }];
});
const menuItems = computed(() =>
menuSections.value.flatMap(section => section.items)
);
const selectedLabel = computed(
() => menuItems.value.find(item => item.isSelected)?.label || ''
);
const handleAction = ({ value }) => {
toggleDropdown(false);
modelValue.value = value;
};
</script>
<template>
<div
v-on-click-outside="() => toggleDropdown(false)"
class="relative flex items-center group"
>
<Button
sm
slate
faded
trailing-icon
icon="i-lucide-chevron-down"
:label="selectedLabel"
class="rounded-md group-hover:bg-n-alpha-2"
@click="toggleDropdown()"
/>
<DropdownMenu
v-if="showDropdown"
:menu-items="menuItems"
:menu-sections="menuSections"
class="mt-1 ltr:right-0 rtl:left-0 top-full"
@action="handleAction($event)"
/>
</div>
</template>
@@ -1,76 +0,0 @@
<script setup>
import { computed } from 'vue';
import { useI18n } from 'vue-i18n';
const { t } = useI18n();
// Flagged responses broken down by report reason, mapped from
// captain_message_reports.report_reason (sample data).
const flagReasons = [
{
key: 'incorrect',
label: t('CAPTAIN.OVERVIEW.FLAG_REASONS.INCORRECT'),
count: 11,
},
{
key: 'incomplete',
label: t('CAPTAIN.OVERVIEW.FLAG_REASONS.INCOMPLETE'),
count: 7,
},
{
key: 'outdated',
label: t('CAPTAIN.OVERVIEW.FLAG_REASONS.OUTDATED'),
count: 4,
},
{
key: 'inappropriate',
label: t('CAPTAIN.OVERVIEW.FLAG_REASONS.INAPPROPRIATE'),
count: 2,
},
{ key: 'other', label: t('CAPTAIN.OVERVIEW.FLAG_REASONS.OTHER'), count: 3 },
];
const total = computed(() =>
flagReasons.reduce((sum, reason) => sum + reason.count, 0)
);
// Flagged responses as a share of all Captain replies (sample data).
const rate = '1.3%';
</script>
<template>
<div
class="flex flex-col gap-4 p-5 border rounded-xl bg-n-solid-1 border-n-weak"
>
<div class="flex items-center justify-between">
<span class="text-sm font-medium text-n-slate-12">
{{ $t('CAPTAIN.OVERVIEW.FLAGGED.TITLE') }}
</span>
<span class="text-sm tabular-nums text-n-slate-11">
{{ $t('CAPTAIN.OVERVIEW.FLAGGED.TOTAL', { count: total, rate }) }}
</span>
</div>
<div class="flex flex-col gap-3">
<div
v-for="reason in flagReasons"
:key="reason.key"
class="flex items-center gap-3"
>
<span class="w-28 text-xs truncate text-n-slate-11 shrink-0">
{{ reason.label }}
</span>
<div class="flex-1 h-2 overflow-hidden rounded-full bg-n-alpha-2">
<div
class="h-full rounded-full bg-n-amber-9"
:style="{ width: `${Math.round((reason.count / total) * 100)}%` }"
/>
</div>
<span
class="w-6 text-xs font-medium text-right tabular-nums text-n-slate-12"
>
{{ reason.count }}
</span>
</div>
</div>
</div>
</template>
@@ -1,109 +0,0 @@
<script setup>
import { computed, ref, watch } from 'vue';
import { useRoute } from 'vue-router';
import CaptainAssistant from 'dashboard/api/captain/assistant';
const props = defineProps({
range: {
type: String,
default: '30',
},
});
const route = useRoute();
const assistantId = computed(() => route.params.assistantId);
// Markdown summary generated by the model from the assistant's stats (served by
// the captain/assistants/:id/summary endpoint). Numbers are emphasised with
// **bold** so we can highlight them.
const welcomeMarkdown = ref('');
const isLoading = ref(false);
const fetchSummary = async () => {
isLoading.value = true;
try {
const { data } = await CaptainAssistant.getSummary({
assistantId: assistantId.value,
range: props.range,
});
welcomeMarkdown.value = data.message ?? '';
} catch {
welcomeMarkdown.value = '';
} finally {
isLoading.value = false;
}
};
watch([() => props.range, assistantId], fetchSummary, { immediate: true });
// Split a line on **bold** runs so we can render emphasised numbers as
// brand-highlighted spans with Tailwind (instead of styling raw HTML).
const parseSegments = text => {
const parts = [];
const regex = /\*\*(.+?)\*\*/g;
let lastIndex = 0;
let match = regex.exec(text);
while (match) {
if (match.index > lastIndex) {
parts.push({ text: text.slice(lastIndex, match.index) });
}
parts.push({ text: match[1], bold: true });
lastIndex = regex.lastIndex;
match = regex.exec(text);
}
if (lastIndex < text.length) {
parts.push({ text: text.slice(lastIndex) });
}
return parts.map((part, index) => ({ ...part, key: index }));
};
// Break the markdown into paragraphs on blank lines so newline breaks survive
// (a single <p> would collapse them), each parsed into highlightable segments.
const paragraphs = computed(() =>
welcomeMarkdown.value
.split(/\n{2,}/)
.map(block => block.trim())
.filter(Boolean)
.map((block, index) => ({ key: index, segments: parseSegments(block) }))
);
</script>
<!-- eslint-disable-next-line vue/no-root-v-if -->
<template>
<div v-if="isLoading || welcomeMarkdown" class="flex flex-col gap-3">
<div class="flex items-center gap-1.5 text-n-slate-10">
<span class="i-lucide-sparkles size-3.5" />
<span class="text-xs">
{{ $t('CAPTAIN.OVERVIEW.WELCOME.LABEL') }}
</span>
</div>
<div
v-if="isLoading"
class="flex flex-col gap-5"
:aria-label="$t('CAPTAIN.OVERVIEW.WELCOME.LOADING')"
>
<div class="flex flex-col gap-2.5">
<div class="w-full h-5 rounded bg-n-slate-3 animate-pulse" />
<div class="w-11/12 h-5 rounded bg-n-slate-3 animate-pulse" />
<div class="w-4/6 h-5 rounded bg-n-slate-3 animate-pulse" />
</div>
<div class="w-5/6 h-5 rounded bg-n-slate-3 animate-pulse" />
</div>
<template v-else>
<p
v-for="paragraph in paragraphs"
:key="paragraph.key"
class="text-lg leading-relaxed text-n-slate-12"
>
<template v-for="segment in paragraph.segments" :key="segment.key">
<span
v-if="segment.bold"
class="font-bold tabular-nums text-n-brand"
>{{ segment.text }}</span
>
<template v-else>{{ segment.text }}</template>
</template>
</p>
</template>
</div>
</template>
@@ -440,14 +440,6 @@ const menuItems = computed(() => {
label: t('SIDEBAR.CAPTAIN'),
activeOn: ['captain_assistants_create_index'],
children: [
{
name: 'Overview',
label: t('SIDEBAR.CAPTAIN_OVERVIEW'),
activeOn: ['captain_assistants_overview_index'],
to: accountScopedRoute('captain_assistants_index', {
navigationPath: 'captain_assistants_overview_index',
}),
},
{
name: 'FAQs',
label: t('SIDEBAR.CAPTAIN_RESPONSES'),
@@ -171,6 +171,9 @@ export default {
return this.isATwilioWhatsAppChannel && !this.isPrivate;
},
isPrivate() {
if (this.isAgentBotOwned) {
return true;
}
if (
this.currentChat.can_reply ||
this.isAWhatsAppChannel ||
@@ -197,10 +200,14 @@ export default {
},
isReplyRestricted() {
return (
!this.currentChat?.can_reply &&
!(this.isAWhatsAppChannel || this.isAPIInbox)
this.isAgentBotOwned ||
(!this.currentChat?.can_reply &&
!(this.isAWhatsAppChannel || this.isAPIInbox))
);
},
isAgentBotOwned() {
return this.currentChat?.meta?.assignee_type === 'AgentBot';
},
inboxId() {
return this.currentChat.inbox_id;
},
@@ -462,6 +469,11 @@ export default {
return;
}
if (this.isAgentBotOwned) {
this.replyType = REPLY_EDITOR_MODES.NOTE;
return;
}
if (canReply || this.isAWhatsAppChannel || this.isAPIInbox) {
this.replyType = REPLY_EDITOR_MODES.REPLY;
} else {
@@ -501,6 +513,9 @@ export default {
mounted() {
this.getFromDraft();
if (this.isAgentBotOwned) {
this.replyType = REPLY_EDITOR_MODES.NOTE;
}
// Don't use the keyboard listener mixin here as the events here are supposed to be
// working even if the editor is focussed.
document.addEventListener('paste', this.onPaste);
@@ -921,6 +936,9 @@ export default {
this.hideContentTemplatesModal();
},
setReplyMode(mode = REPLY_EDITOR_MODES.REPLY) {
if (this.isAgentBotOwned && mode === REPLY_EDITOR_MODES.REPLY) {
return;
}
// Clear attachments when switching between private note and reply modes
// This is to prevent from breaking the upload rules
if (this.attachedFiles.length > 0) this.attachedFiles = [];
@@ -4,7 +4,6 @@ import { useStore } from 'vuex';
import { useMapGetter } from 'dashboard/composables/store';
import { useAlert } from 'dashboard/composables';
import { useI18n } from 'vue-i18n';
import wootConstants from 'dashboard/constants/globals';
import Banner from 'dashboard/components/ui/Banner.vue';
@@ -34,6 +33,7 @@ const assignedAgent = computed({
store.dispatch('setCurrentChatAssignee', {
conversationId: currentChat.value?.id,
assignee: agent,
assigneeType: agent ? 'User' : null,
});
store.dispatch('assignAgent', {
conversationId: currentChat.value?.id,
@@ -42,9 +42,8 @@ const assignedAgent = computed({
},
});
const isUserTyping = computed(
() => props.message !== '' && !props.isOnPrivateNote
);
const hasMessage = computed(() => props.message !== '');
const isUserTyping = computed(() => hasMessage.value && !props.isOnPrivateNote);
const isUnassigned = computed(() => !assignedAgent.value);
const isAssignedToOtherAgent = computed(
() => assignedAgent.value?.id !== currentUser.value?.id
@@ -56,11 +55,11 @@ const showSelfAssignBanner = computed(() => {
);
});
const showBotHandoffBanner = computed(
() =>
isUserTyping.value &&
currentChat.value?.status === wootConstants.STATUS_TYPE.PENDING
);
const showBotHandoffBanner = computed(() => {
return (
hasMessage.value && currentChat.value?.meta?.assignee_type === 'AgentBot'
);
});
const botHandoffActionLabel = computed(() => {
return assignedAgent.value?.id === currentUser.value?.id
@@ -89,7 +88,7 @@ const onClickSelfAssign = async () => {
const reopenConversation = async () => {
await store.dispatch('toggleStatus', {
conversationId: currentChat.value?.id,
status: wootConstants.STATUS_TYPE.OPEN,
status: 'open',
});
};
@@ -19,7 +19,6 @@ const FEATURE_HELP_URLS = {
webhook: 'https://chwt.app/hc/webhooks',
billing: 'https://chwt.app/pricing',
saml: 'https://chwt.app/hc/saml',
captain: 'https://chwt.app/captain-docs',
captain_billing: 'https://chwt.app/hc/captain_billing',
};
@@ -392,93 +392,6 @@
"CAPTAIN": {
"NAME": "Captain",
"HEADER_KNOW_MORE": "Know more",
"OVERVIEW": {
"HEADER": "Overview",
"WELCOME": {
"LABEL": "Captain summary",
"LOADING": "Generating summary…"
},
"INBOX_BANNER": {
"TEXT": "This assistant isn't connected to any inbox yet, so it won't respond to conversations.",
"ACTION": "Connect inbox",
"DISMISS": "Dismiss"
},
"COVERAGE_BANNER": {
"TEXT": "{count} FAQs are pending review, keeping coverage at {coverage}%. Approve them so your assistant can resolve more on its own.",
"ACTION": "Review FAQs",
"DISMISS": "Dismiss"
},
"RANGES": {
"LAST_DAYS": "Last {count} days",
"THIS_MONTH": "This month",
"LAST_MONTH": "Last month"
},
"METRICS": {
"HANDLED": {
"LABEL": "Conversations handled",
"HINT": "Distinct conversations this assistant replied in."
},
"AUTO_RESOLUTION": {
"LABEL": "Auto-resolution rate",
"HINT": "Share of handled conversations closed without a human reply."
},
"HANDOFF": {
"LABEL": "Handoff rate",
"HINT": "Share of handled conversations escalated to a human agent."
},
"HOURS_SAVED": {
"LABEL": "Hours saved",
"HINT": "Estimate: Captain replies times the team's average response time. Directional, not measured labor."
},
"REOPEN": {
"LABEL": "Reopen rate",
"HINT": "Auto-resolved conversations that were reopened afterwards."
},
"DEPTH": {
"LABEL": "Messages / conversation",
"HINT": "Average replies the assistant sends per conversation."
}
},
"KNOWLEDGE": {
"TITLE": "Knowledge coverage",
"COVERAGE": "{pct}% approved",
"APPROVED": "Approved FAQs",
"PENDING": "Pending FAQs",
"DOCUMENTS": "Documents"
},
"FLAGGED": {
"TITLE": "Response quality",
"TOTAL": "{count} flagged · {rate}"
},
"CREDITS": {
"TITLE": "Credit usage",
"UNIT": "credits",
"LEGEND": "Daily credits used",
"AXIS_START": "{count}d ago",
"AXIS_END": "Today"
},
"LINKS": {
"DOCS": {
"TITLE": "Captain docs",
"DESCRIPTION": "Guides and how-tos for Captain"
},
"PLAYGROUND": {
"TITLE": "Playground",
"DESCRIPTION": "Test this assistant's replies"
},
"BILLING": {
"TITLE": "Billing",
"DESCRIPTION": "Manage credits and plan"
}
},
"FLAG_REASONS": {
"INCORRECT": "Incorrect info",
"INCOMPLETE": "Incomplete",
"OUTDATED": "Outdated",
"INAPPROPRIATE": "Inappropriate",
"OTHER": "Other"
}
},
"ASSISTANT_SWITCHER": {
"ASSISTANTS": "Assistants",
"SWITCH_ASSISTANT": "Switch between assistants",
@@ -581,6 +494,10 @@
"PLACEHOLDER": "Enter assistant name",
"ERROR": "The name is required"
},
"TEMPERATURE": {
"LABEL": "Response Temperature",
"DESCRIPTION": "Adjust how creative or restrictive the assistant's responses should be. Lower values produce more focused and deterministic responses, while higher values allow for more creative and varied outputs."
},
"DESCRIPTION": {
"LABEL": "Description",
"PLACEHOLDER": "Enter assistant description",
@@ -324,7 +324,6 @@
"ALL_COMPANIES": "All Companies",
"CAPTAIN": "Captain",
"CAPTAIN_ASSISTANTS": "Assistants",
"CAPTAIN_OVERVIEW": "Overview",
"CAPTAIN_DOCUMENTS": "Documents",
"CAPTAIN_RESPONSES": "FAQs",
"CAPTAIN_TOOLS": "Tools",
@@ -6,7 +6,6 @@ import ContextMenu from 'dashboard/components/ui/ContextMenu.vue';
import AddCannedModal from 'dashboard/routes/dashboard/settings/canned/AddCanned.vue';
import { useSnakeCase } from 'dashboard/composables/useTransformKeys';
import { copyTextToClipboard } from 'shared/helpers/clipboard';
import { parseAPIErrorResponse } from 'dashboard/store/utils/api';
import { conversationUrl, frontendURL } from '../../../helper/URLHelper';
import {
ACCOUNT_EVENTS,
@@ -120,20 +119,16 @@ export default {
handleClose(e) {
this.$emit('close', e);
},
async handleTranslate() {
handleTranslate() {
const { locale: accountLocale } = this.getAccount(this.currentAccountId);
const agentLocale = this.getUISettings?.locale;
const targetLanguage = agentLocale || accountLocale || 'en';
try {
await this.$store.dispatch('translateMessage', {
conversationId: this.conversationId,
messageId: this.messageId,
targetLanguage,
});
useTrack(CONVERSATION_EVENTS.TRANSLATE_A_MESSAGE);
} catch (error) {
useAlert(parseAPIErrorResponse(error));
}
this.$store.dispatch('translateMessage', {
conversationId: this.conversationId,
messageId: this.messageId,
targetLanguage,
});
useTrack(CONVERSATION_EVENTS.TRANSLATE_A_MESSAGE);
this.handleClose();
},
handleReplyTo() {
@@ -1,147 +0,0 @@
<script setup>
import { computed, ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { useRoute } from 'vue-router';
import { FEATURE_FLAGS } from 'dashboard/featureFlags';
import CaptainAssistant from 'dashboard/api/captain/assistant';
import PageLayout from 'dashboard/components-next/captain/PageLayout.vue';
import RangeSelector from 'dashboard/components-next/captain/pageComponents/overview/RangeSelector.vue';
import WelcomeCard from 'dashboard/components-next/captain/pageComponents/overview/WelcomeCard.vue';
import MetricCard from 'dashboard/components-next/captain/pageComponents/overview/MetricCard.vue';
import KnowledgeCard from 'dashboard/components-next/captain/pageComponents/overview/KnowledgeCard.vue';
import QuickLinks from 'dashboard/components-next/captain/pageComponents/overview/QuickLinks.vue';
import InboxBanner from 'dashboard/components-next/captain/pageComponents/overview/InboxBanner.vue';
import CoverageBanner from 'dashboard/components-next/captain/pageComponents/overview/CoverageBanner.vue';
const { t } = useI18n();
const route = useRoute();
const selectedRange = ref('this_month');
const assistantId = computed(() => route.params.assistantId);
const stats = ref(null);
const fetchStats = async () => {
try {
const { data } = await CaptainAssistant.getStats({
assistantId: assistantId.value,
range: selectedRange.value,
});
stats.value = data;
} catch {
stats.value = null;
}
};
watch([selectedRange, assistantId], fetchStats, { immediate: true });
// `direction` says whether a rising trend is good ('up'), bad ('down'), or
// neutral, so we can colour the delta independently of its sign.
const resolveTrendGood = (trendValue, direction) => {
if (direction === 'neutral' || trendValue === 0) return null;
return direction === 'up' ? trendValue > 0 : trendValue < 0;
};
// Trend units mirror the backend pack mode: a relative percent change ('%') for
// :percent metrics, a percentage-point delta (' pts') for rate metrics packed as
// :point, and a plain number for :absolute counts like conversation depth.
const TREND_SUFFIX = { percent: '%', point: ' pts', absolute: '' };
const metricFor = (statKey, formatValue, direction, trendKind = 'percent') => {
const data = stats.value?.[statKey];
if (!data) return { value: '—', trend: '', trendGood: null };
const sign = data.trend > 0 ? '+' : '';
return {
value: formatValue(data.current),
trend: `${sign}${data.trend}${TREND_SUFFIX[trendKind]}`,
trendGood: resolveTrendGood(data.trend, direction),
};
};
const metrics = computed(() => [
{
key: 'handled',
label: t('CAPTAIN.OVERVIEW.METRICS.HANDLED.LABEL'),
hint: t('CAPTAIN.OVERVIEW.METRICS.HANDLED.HINT'),
...metricFor('conversations_handled', v => v.toLocaleString(), 'up'),
},
{
key: 'autoResolution',
label: t('CAPTAIN.OVERVIEW.METRICS.AUTO_RESOLUTION.LABEL'),
hint: t('CAPTAIN.OVERVIEW.METRICS.AUTO_RESOLUTION.HINT'),
...metricFor('auto_resolution_rate', v => `${v}%`, 'up', 'point'),
},
{
key: 'handoff',
label: t('CAPTAIN.OVERVIEW.METRICS.HANDOFF.LABEL'),
hint: t('CAPTAIN.OVERVIEW.METRICS.HANDOFF.HINT'),
...metricFor('handoff_rate', v => `${v}%`, 'down', 'point'),
},
{
key: 'hoursSaved',
label: t('CAPTAIN.OVERVIEW.METRICS.HOURS_SAVED.LABEL'),
hint: t('CAPTAIN.OVERVIEW.METRICS.HOURS_SAVED.HINT'),
...metricFor('hours_saved', v => `${v}h`, 'up'),
},
{
key: 'reopen',
label: t('CAPTAIN.OVERVIEW.METRICS.REOPEN.LABEL'),
hint: t('CAPTAIN.OVERVIEW.METRICS.REOPEN.HINT'),
...metricFor('reopen_rate', v => `${v}%`, 'down', 'point'),
},
{
key: 'depth',
label: t('CAPTAIN.OVERVIEW.METRICS.DEPTH.LABEL'),
hint: t('CAPTAIN.OVERVIEW.METRICS.DEPTH.HINT'),
...metricFor(
'conversation_depth',
v => v.toFixed(1),
'neutral',
'absolute'
),
},
]);
</script>
<template>
<PageLayout
:header-title="$t('CAPTAIN.OVERVIEW.HEADER')"
:is-empty="false"
:show-pagination-footer="false"
:show-know-more="false"
:feature-flag="FEATURE_FLAGS.CAPTAIN"
>
<template #headerActions>
<RangeSelector v-model="selectedRange" />
</template>
<template #body>
<div class="flex flex-col gap-6">
<InboxBanner />
<CoverageBanner :knowledge="stats?.knowledge" />
<WelcomeCard :range="selectedRange" />
<div
class="grid grid-cols-1 gap-px overflow-hidden border rounded-xl sm:grid-cols-2 lg:grid-cols-3 bg-n-weak border-n-weak"
>
<MetricCard
v-for="metric in metrics"
:key="metric.key"
:label="metric.label"
:value="metric.value"
:trend="metric.trend"
:hint="metric.hint"
:trend-good="metric.trendGood"
/>
</div>
<KnowledgeCard :knowledge="stats?.knowledge" />
<QuickLinks />
</div>
</template>
</PageLayout>
</template>
@@ -6,7 +6,6 @@ import CaptainPageRouteView from './pages/CaptainPageRouteView.vue';
import AssistantsIndexPage from './pages/AssistantsIndexPage.vue';
import AssistantEmptyStateIndex from './assistants/Index.vue';
import AssistantOverviewIndex from './assistants/overview/Index.vue';
import AssistantSettingsIndex from './assistants/settings/Settings.vue';
import AssistantInboxesIndex from './assistants/inboxes/Index.vue';
import AssistantPlaygroundIndex from './assistants/playground/Index.vue';
@@ -37,12 +36,6 @@ const metaV2 = {
};
const assistantRoutes = [
{
path: frontendURL('accounts/:accountId/captain/:assistantId/overview'),
component: AssistantOverviewIndex,
name: 'captain_assistants_overview_index',
meta,
},
{
path: frontendURL('accounts/:accountId/captain/:assistantId/faqs'),
component: ResponsesIndex,
@@ -53,7 +53,6 @@ const routeToLastActiveAssistant = () => {
const { navigationPath } = route.params;
const isAValidRoute = [
'captain_assistants_overview_index', // Overview page
'captain_assistants_responses_index', // Faq page
'captain_assistants_documents_index', // Document page
'captain_assistants_scenarios_index', // Scenario page
@@ -223,8 +223,11 @@ const actions = {
}
},
setCurrentChatAssignee({ commit }, { conversationId, assignee }) {
commit(types.ASSIGN_AGENT, { conversationId, assignee });
setCurrentChatAssignee(
{ commit },
{ conversationId, assignee, assigneeType }
) {
commit(types.ASSIGN_AGENT, { conversationId, assignee, assigneeType });
},
assignTeam: async ({ dispatch }, { conversationId, teamId }) => {
@@ -2,10 +2,14 @@ import MessageApi from '../../../../api/inbox/message';
export default {
async translateMessage(_, { conversationId, messageId, targetLanguage }) {
await MessageApi.translateMessage(
conversationId,
messageId,
targetLanguage
);
try {
await MessageApi.translateMessage(
conversationId,
messageId,
targetLanguage
);
} catch (error) {
// ignore error
}
},
};
@@ -108,10 +108,13 @@ export const mutations = {
}
},
[types.ASSIGN_AGENT](_state, { conversationId, assignee }) {
[types.ASSIGN_AGENT](_state, { conversationId, assignee, assigneeType }) {
const chat = getConversationById(_state)(conversationId);
if (chat) {
chat.meta.assignee = assignee;
if (assigneeType !== undefined) {
chat.meta.assignee_type = assigneeType;
}
}
},
@@ -716,6 +716,21 @@ describe('#mutations', () => {
expect(state.allConversations[0].meta.assignee).toEqual(assignee);
expect(state.allConversations[1].meta.assignee).toBeUndefined();
});
it('should update assignee type when provided', () => {
const assignee = { id: 1, name: 'Agent' };
const state = {
allConversations: [{ id: 1, meta: { assignee_type: 'AgentBot' } }],
};
mutations[types.ASSIGN_AGENT](state, {
conversationId: 1,
assignee,
assigneeType: 'User',
});
expect(state.allConversations[0].meta.assignee_type).toEqual('User');
});
});
describe('#ASSIGN_PRIORITY', () => {
+35 -68
View File
@@ -16,12 +16,12 @@ class ReportingEventListener < BaseListener
user_id: conversation.assignee_id,
conversation_id: conversation.id,
event_start_time: conversation.created_at,
event_end_time: event_end_time,
**actor_attributes(actor_from_event(event))
event_end_time: event_end_time
)
create_bot_resolved_event(conversation, reporting_event)
persist_reporting_event(reporting_event)
reporting_event.save!
safe_rollup(reporting_event)
end
def first_reply_created(event)
@@ -39,11 +39,11 @@ class ReportingEventListener < BaseListener
user_id: message.sender_id,
conversation_id: conversation.id,
event_start_time: last_non_human_activity(conversation),
event_end_time: message.created_at,
**actor_attributes(actor_from_event(event) || message.sender)
event_end_time: message.created_at
)
persist_reporting_event(reporting_event)
reporting_event.save!
safe_rollup(reporting_event)
end
def reply_created(event)
@@ -65,10 +65,10 @@ class ReportingEventListener < BaseListener
user_id: conversation.assignee_id,
conversation_id: conversation.id,
event_start_time: waiting_since,
event_end_time: message.created_at,
**actor_attributes(actor_from_event(event) || message.sender)
event_end_time: message.created_at
)
persist_reporting_event(reporting_event)
reporting_event.save!
safe_rollup(reporting_event)
end
def conversation_bot_handoff(event)
@@ -92,10 +92,10 @@ class ReportingEventListener < BaseListener
user_id: conversation.assignee_id,
conversation_id: conversation.id,
event_start_time: conversation.created_at,
event_end_time: event_end_time,
**actor_attributes(actor_from_event(event))
event_end_time: event_end_time
)
persist_reporting_event(reporting_event)
reporting_event.save!
safe_rollup(reporting_event)
end
def conversation_captain_inference_resolved(event)
@@ -116,53 +116,43 @@ class ReportingEventListener < BaseListener
name: 'conversation_resolved'
).where('event_end_time <= ?', event_end_time).order(event_end_time: :desc).first
create_conversation_opened_event(
conversation,
conversation_opened_event_attributes(conversation, last_resolved_event, event_end_time),
actor_from_event(event)
)
# For first-time openings, value is 0
# For reopenings, calculate time since resolution
if last_resolved_event
time_since_resolved = event_end_time.to_i - last_resolved_event.event_end_time.to_i
business_hours_value = business_hours(conversation.inbox, last_resolved_event.event_end_time, event_end_time)
start_time = last_resolved_event.event_end_time
else
time_since_resolved = 0
business_hours_value = 0
start_time = conversation.created_at
end
create_conversation_opened_event(conversation, time_since_resolved, business_hours_value, start_time, event_end_time)
end
private
def conversation_opened_event_attributes(conversation, last_resolved_event, event_end_time)
return first_conversation_opened_event_attributes(conversation, event_end_time) if last_resolved_event.blank?
{
value: event_end_time.to_i - last_resolved_event.event_end_time.to_i,
value_in_business_hours: business_hours(conversation.inbox, last_resolved_event.event_end_time, event_end_time),
event_start_time: last_resolved_event.event_end_time,
event_end_time: event_end_time
}
end
def first_conversation_opened_event_attributes(conversation, event_end_time)
{
value: 0,
value_in_business_hours: 0,
event_start_time: conversation.created_at,
event_end_time: event_end_time
}
end
def create_conversation_opened_event(conversation, event_attributes, actor)
def create_conversation_opened_event(conversation, time_since_resolved, business_hours_value, start_time, event_end_time)
reporting_event = ReportingEvent.new(
name: 'conversation_opened',
value: time_since_resolved,
value_in_business_hours: business_hours_value,
account_id: conversation.account_id,
inbox_id: conversation.inbox_id,
user_id: conversation.assignee_id,
conversation_id: conversation.id,
**event_attributes,
**actor_attributes(actor)
event_start_time: start_time,
event_end_time: event_end_time
)
persist_reporting_event(reporting_event, rollup: false)
reporting_event.save!
end
def create_captain_inference_event(event, event_name)
conversation = extract_conversation_and_account(event)[0]
time_to_event = event.timestamp.to_i - conversation.created_at.to_i
reporting_event = ReportingEvent.new(
ReportingEvent.create!(
name: event_name,
value: time_to_event,
account_id: conversation.account_id,
@@ -170,10 +160,8 @@ class ReportingEventListener < BaseListener
user_id: conversation.assignee_id,
conversation_id: conversation.id,
event_start_time: conversation.created_at,
event_end_time: event.timestamp,
**actor_attributes(actor_from_event(event))
event_end_time: event.timestamp
)
persist_reporting_event(reporting_event, rollup: false)
end
def create_bot_resolved_event(conversation, reporting_event)
@@ -183,29 +171,8 @@ class ReportingEventListener < BaseListener
bot_resolved_event = reporting_event.dup
bot_resolved_event.name = 'conversation_bot_resolved'
persist_reporting_event(bot_resolved_event)
end
def persist_reporting_event(reporting_event, rollup: true)
reporting_event.save!
safe_rollup(reporting_event) if rollup
update_captain_conversation_fact(reporting_event)
end
def update_captain_conversation_fact(reporting_event)
return unless defined?(Captain::ConversationFactUpdater)
Captain::ConversationFactUpdater.record_reporting_event(reporting_event)
end
def actor_from_event(event)
event.data[:performed_by]
end
def actor_attributes(actor)
return {} if actor.blank? || actor.id.blank?
{ actor_type: actor.class.name, actor_id: actor.id }
bot_resolved_event.save!
safe_rollup(bot_resolved_event)
end
def safe_rollup(reporting_event)
+1 -1
View File
@@ -343,7 +343,7 @@ class Conversation < ApplicationRecord
def dispatcher_dispatch(event_name, changed_attributes = nil)
Rails.configuration.dispatcher.dispatch(event_name, Time.zone.now, conversation: self, notifiable_assignee_change: notifiable_assignee_change?,
changed_attributes: changed_attributes,
performed_by: Current.executed_by || Current.user)
performed_by: Current.executed_by)
end
def set_unread_count_deletion_data
-2
View File
@@ -45,5 +45,3 @@ class CsatSurveyResponse < ApplicationRecord
# filter by rating value
scope :filter_by_rating, ->(rating) { where(rating: rating) if rating.present? }
end
CsatSurveyResponse.include_mod_with('CsatSurveyResponse')
+1 -1
View File
@@ -34,7 +34,7 @@
# index_messages_on_conversation_id (conversation_id)
# index_messages_on_created_at (created_at)
# index_messages_on_inbox_id (inbox_id)
# index_messages_on_sender_and_created (sender_type,sender_id,created_at)
# index_messages_on_sender_type_and_sender_id (sender_type,sender_id)
# index_messages_on_source_id (source_id)
#
+8 -12
View File
@@ -3,7 +3,6 @@
# Table name: reporting_events
#
# id :bigint not null, primary key
# actor_type :string
# event_end_time :datetime
# event_start_time :datetime
# name :string
@@ -12,22 +11,20 @@
# created_at :datetime not null
# updated_at :datetime not null
# account_id :integer
# actor_id :bigint
# conversation_id :integer
# inbox_id :integer
# user_id :integer
#
# Indexes
#
# idx_reporting_events_on_account_actor_name_created (account_id,actor_type,actor_id,name,created_at)
# index_reporting_events_for_response_distribution (account_id,name,inbox_id,created_at)
# index_reporting_events_on_account_id (account_id)
# index_reporting_events_on_conversation_id (conversation_id)
# index_reporting_events_on_created_at (created_at)
# index_reporting_events_on_inbox_id (inbox_id)
# index_reporting_events_on_name (name)
# index_reporting_events_on_user_id (user_id)
# reporting_events__account_id__name__created_at (account_id,name,created_at)
# index_reporting_events_for_response_distribution (account_id,name,inbox_id,created_at)
# index_reporting_events_on_account_id (account_id)
# index_reporting_events_on_conversation_id (conversation_id)
# index_reporting_events_on_created_at (created_at)
# index_reporting_events_on_inbox_id (inbox_id)
# index_reporting_events_on_name (name)
# index_reporting_events_on_user_id (user_id)
# reporting_events__account_id__name__created_at (account_id,name,created_at)
#
class ReportingEvent < ApplicationRecord
@@ -39,7 +36,6 @@ class ReportingEvent < ApplicationRecord
belongs_to :user, optional: true
belongs_to :inbox, optional: true
belongs_to :conversation, optional: true
belongs_to :actor, polymorphic: true, optional: true
# Scopes for filtering
scope :filter_by_date_range, lambda { |range|
@@ -78,14 +78,6 @@ class Crm::BaseProcessorService
contact.save!
end
def clear_external_id(contact)
return if contact.additional_attributes.blank?
return if contact.additional_attributes['external'].blank?
contact.additional_attributes['external'].delete("#{crm_name}_id")
contact.save!
end
def store_conversation_metadata(conversation, metadata)
# Initialize additional_attributes if it's nil
conversation.additional_attributes = {} if conversation.additional_attributes.nil?
@@ -64,7 +64,7 @@ class Crm::Leadsquared::ProcessorService < Crm::BaseProcessorService
# may not be marked as unique, same with the phone number field
# So we just use the update API if we already have a lead ID
if lead_id.present?
with_stale_lead_recovery(contact, lead_id) { |id| @lead_client.update_lead(lead_data, id) }
@lead_client.update_lead(lead_data, lead_id)
else
new_lead_id = @lead_client.create_or_update_lead(lead_data)
store_external_id(contact, new_lead_id)
@@ -82,9 +82,7 @@ class Crm::Leadsquared::ProcessorService < Crm::BaseProcessorService
return if lead_id.blank?
activity_code = get_activity_code(activity_code_key)
activity_id = with_stale_lead_recovery(conversation.contact, lead_id) do |id|
@activity_client.post_activity(id, activity_code, activity_note)
end
activity_id = @activity_client.post_activity(lead_id, activity_code, activity_note)
return if activity_id.blank?
metadata = {}
@@ -96,31 +94,6 @@ class Crm::Leadsquared::ProcessorService < Crm::BaseProcessorService
log_activity_error(e, activity_type, conversation)
end
# The cached lead id can become stale when the lead is deleted/merged in LeadSquared,
# making LeadSquared reject the call with "Lead not found". When that happens, clear the
# stored id, re-resolve the contact to a fresh lead, and run the operation again once.
def with_stale_lead_recovery(contact, lead_id)
yield(lead_id)
rescue Crm::Leadsquared::Api::BaseClient::ApiError => e
raise unless lead_not_found_error?(e)
Rails.logger.warn("LeadSquared stale lead #{lead_id} for contact ##{contact.id}, clearing and retrying")
clear_external_id(contact)
fresh_lead_id = get_lead_id(contact)
raise if fresh_lead_id.blank? || fresh_lead_id == lead_id
yield(fresh_lead_id)
end
def lead_not_found_error?(error)
return false if error.response.blank?
parsed = error.response.parsed_response
parsed.is_a?(Hash) && parsed['ExceptionType'] == 'MXInvalidEntityReferenceException'
rescue StandardError
false
end
def log_activity_error(error, activity_type, conversation, payload: nil)
ChatwootExceptionTracker.new(error, account: @account).capture_exception
context = "account_id=#{conversation.account_id}, conversation_display_id=#{conversation.display_id}"
@@ -143,7 +116,7 @@ class Crm::Leadsquared::ProcessorService < Crm::BaseProcessorService
unless identifiable_contact?(contact)
Rails.logger.info("Contact not identifiable. Skipping activity for ##{contact.id}")
return nil
nil
end
lead_id = @lead_finder.find_or_create(contact)
-2
View File
@@ -66,8 +66,6 @@ Rails.application.routes.draw do
resources :assistants do
member do
post :playground
get :stats
get :summary
end
collection do
get :tools
@@ -1,22 +0,0 @@
class AddSenderCreatedIndexToMessages < ActiveRecord::Migration[7.1]
disable_ddl_transaction!
# Adds created_at to the (sender_type, sender_id) index so per-assistant
# windowed lookups (Captain Overview stats) can range-scan the time slice
# instead of reading every lifetime row and filtering at the heap. The new
# index is a left-prefix superset of the old one, so the old one is dropped
# to keep write amplification on `messages` neutral.
def up
add_index :messages, [:sender_type, :sender_id, :created_at],
name: 'index_messages_on_sender_and_created', algorithm: :concurrently, if_not_exists: true
remove_index :messages, name: 'index_messages_on_sender_type_and_sender_id',
algorithm: :concurrently, if_exists: true
end
def down
add_index :messages, [:sender_type, :sender_id],
name: 'index_messages_on_sender_type_and_sender_id', algorithm: :concurrently, if_not_exists: true
remove_index :messages, name: 'index_messages_on_sender_and_created',
algorithm: :concurrently, if_exists: true
end
end
@@ -1,13 +0,0 @@
class AddActorToReportingEvents < ActiveRecord::Migration[7.1]
disable_ddl_transaction!
def change
add_column :reporting_events, :actor_type, :string
add_column :reporting_events, :actor_id, :bigint
add_index :reporting_events,
[:account_id, :actor_type, :actor_id, :name, :created_at],
name: 'idx_reporting_events_on_account_actor_name_created',
algorithm: :concurrently
end
end
@@ -1,41 +0,0 @@
class CreateCaptainConversationFacts < ActiveRecord::Migration[7.1]
def change
create_captain_conversation_facts_table
add_captain_conversation_facts_indexes
end
private
def create_captain_conversation_facts_table
create_table :captain_conversation_facts do |t|
t.bigint :account_id, null: false
t.bigint :conversation_id, null: false
t.bigint :assistant_id, null: false
t.bigint :inbox_id, null: false
t.datetime :first_captain_message_at
t.datetime :last_captain_message_at
t.datetime :captain_resolved_at
t.datetime :captain_handed_off_at
t.datetime :first_human_reply_after_captain_at
t.datetime :reopened_after_captain_resolution_at
t.bigint :csat_response_id
t.integer :csat_rating
t.datetime :csat_submitted_at
t.timestamps
end
end
def add_captain_conversation_facts_indexes
add_index :captain_conversation_facts, :account_id
add_index :captain_conversation_facts, :conversation_id, unique: true
add_index :captain_conversation_facts, [:account_id, :assistant_id, :first_captain_message_at],
name: 'idx_captain_facts_on_account_assistant_first_message'
add_index :captain_conversation_facts, [:account_id, :captain_resolved_at],
name: 'idx_captain_facts_on_account_resolved_at'
add_index :captain_conversation_facts, [:account_id, :captain_handed_off_at],
name: 'idx_captain_facts_on_account_handed_off_at'
add_index :captain_conversation_facts, [:account_id, :csat_submitted_at],
name: 'idx_captain_facts_on_account_csat_submitted_at'
end
end
+2 -29
View File
@@ -10,7 +10,7 @@
#
# It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema[7.1].define(version: 2026_07_01_001000) do
ActiveRecord::Schema[7.1].define(version: 2026_06_20_000000) do
# These extensions should be enabled to support this database
enable_extension "pg_stat_statements"
enable_extension "pg_trgm"
@@ -350,30 +350,6 @@ ActiveRecord::Schema[7.1].define(version: 2026_07_01_001000) do
t.index ["account_id"], name: "index_captain_assistants_on_account_id"
end
create_table "captain_conversation_facts", force: :cascade do |t|
t.bigint "account_id", null: false
t.bigint "conversation_id", null: false
t.bigint "assistant_id", null: false
t.bigint "inbox_id", null: false
t.datetime "first_captain_message_at"
t.datetime "last_captain_message_at"
t.datetime "captain_resolved_at"
t.datetime "captain_handed_off_at"
t.datetime "first_human_reply_after_captain_at"
t.datetime "reopened_after_captain_resolution_at"
t.bigint "csat_response_id"
t.integer "csat_rating"
t.datetime "csat_submitted_at"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.index ["account_id", "assistant_id", "first_captain_message_at"], name: "idx_captain_facts_on_account_assistant_first_message"
t.index ["account_id", "captain_handed_off_at"], name: "idx_captain_facts_on_account_handed_off_at"
t.index ["account_id", "captain_resolved_at"], name: "idx_captain_facts_on_account_resolved_at"
t.index ["account_id", "csat_submitted_at"], name: "idx_captain_facts_on_account_csat_submitted_at"
t.index ["account_id"], name: "index_captain_conversation_facts_on_account_id"
t.index ["conversation_id"], name: "index_captain_conversation_facts_on_conversation_id", unique: true
end
create_table "captain_custom_tools", force: :cascade do |t|
t.bigint "account_id", null: false
t.string "slug", null: false
@@ -1058,7 +1034,7 @@ ActiveRecord::Schema[7.1].define(version: 2026_07_01_001000) do
t.index ["conversation_id"], name: "index_messages_on_conversation_id"
t.index ["created_at"], name: "index_messages_on_created_at"
t.index ["inbox_id"], name: "index_messages_on_inbox_id"
t.index ["sender_type", "sender_id", "created_at"], name: "index_messages_on_sender_and_created"
t.index ["sender_type", "sender_id"], name: "index_messages_on_sender_type_and_sender_id"
t.index ["source_id"], name: "index_messages_on_source_id"
end
@@ -1191,9 +1167,6 @@ ActiveRecord::Schema[7.1].define(version: 2026_07_01_001000) do
t.float "value_in_business_hours"
t.datetime "event_start_time", precision: nil
t.datetime "event_end_time", precision: nil
t.string "actor_type"
t.bigint "actor_id"
t.index ["account_id", "actor_type", "actor_id", "name", "created_at"], name: "idx_reporting_events_on_account_actor_name_created"
t.index ["account_id", "name", "created_at"], name: "reporting_events__account_id__name__created_at"
t.index ["account_id", "name", "inbox_id", "created_at"], name: "index_reporting_events_for_response_distribution"
t.index ["account_id"], name: "index_reporting_events_on_account_id"
@@ -1,246 +0,0 @@
# Computes per-assistant overview metrics for the Captain Overview page.
# Each metric is returned for the current window and the previous equal-length
# window, plus a derived trend.
#
# Queries are batched to cut round trips: the message-derived counts (handled,
# public replies, depth) and the average reply time are each computed for both
# windows in a single scan via conditional FILTER aggregation.
class Captain::AssistantStatsBuilder
RESOLVED_EVENT_NAMES = %w[conversation_captain_inference_resolved conversation_bot_resolved].freeze
HANDOFF_EVENT_NAMES = %w[conversation_captain_inference_handoff conversation_bot_handoff].freeze
DEFAULT_RANGE = '30'.freeze
ALLOWED_RANGES = %w[7 30 90 this_month last_month].freeze
attr_reader :assistant, :account, :range
# `range` is either a day count ('7', '30', '90') or a named period
# ('this_month', 'last_month'). The previous window mirrors the current one:
# the preceding N days for day ranges, or the preceding month for month ranges.
# `timezone_offset` is the viewer's UTC offset in hours (as the reports API sends
# it), so month/day boundaries anchor to the viewer's day rather than UTC.
def initialize(assistant, range = DEFAULT_RANGE, timezone_offset = nil)
@assistant = assistant
@account = assistant.account
@range = ALLOWED_RANGES.include?(range.to_s) ? range.to_s : DEFAULT_RANGE
@timezone = ActiveSupport::TimeZone[timezone_offset.to_f] || Time.zone
end
def metrics
messages = message_window_metrics
reply_times = avg_reply_times
current = window_metrics(current_range, messages[:current], reply_times[:current])
previous = window_metrics(previous_range, messages[:previous], reply_times[:previous])
build_metrics(current, previous)
end
# Human-readable description of the period the metrics cover, for grounding the
# LLM summary in real dates.
def period
{ label: period_label, starts_on: current_range.first.to_date, ends_on: current_range.last.to_date }
end
private
def build_metrics(current, previous)
{
conversations_handled: pack(current[:handled], previous[:handled], :percent),
auto_resolution_rate: pack(current[:auto_resolution], previous[:auto_resolution], :point),
handoff_rate: pack(current[:handoff], previous[:handoff], :point),
hours_saved: pack(current[:hours_saved], previous[:hours_saved], :percent),
reopen_rate: pack(current[:reopen], previous[:reopen], :point),
conversation_depth: pack(current[:depth], previous[:depth], :absolute),
knowledge: knowledge
}
end
def period_label
{ 'this_month' => 'this month', 'last_month' => 'last month' }[range.to_s] || "the last #{range.to_i} days"
end
def current_range
resolved_ranges[:current]
end
def previous_range
resolved_ranges[:previous]
end
def resolved_ranges
@resolved_ranges ||= case range.to_s
when 'this_month' then this_month_ranges
when 'last_month' then last_month_ranges
else day_ranges
end
end
# Current time anchored to the viewer's timezone, so calendar boundaries land on
# the viewer's day instead of UTC's.
def now
@now ||= Time.current.in_time_zone(@timezone)
end
def this_month_ranges
start = now.beginning_of_month
elapsed = now - start
previous_start = start - 1.month
# Clamp to the previous month's end so a longer current month can't pull the
# comparison window into the current month and double-count its rows.
previous_end = [previous_start + elapsed, previous_start.end_of_month].min
{ current: start..now, previous: previous_start..previous_end }
end
def last_month_ranges
start = (now - 1.month).beginning_of_month
previous_start = start - 1.month
{ current: start..start.end_of_month, previous: previous_start..previous_start.end_of_month }
end
def day_ranges
days = range.to_i
{ current: (now - days.days)..now, previous: (now - (2 * days).days)..(now - days.days) }
end
# Combines the per-window message counts and reply time with the reporting-event metrics for one window.
def window_metrics(range, message_counts, avg_reply)
handled = message_counts[:handled]
public_count = message_counts[:public_count]
depth_conversations = message_counts[:depth_conversations]
resolution = resolution_counts(range)
{
handled: handled,
auto_resolution: rate(resolution[:resolved], handled),
handoff: rate(resolution[:handoff], handled),
hours_saved: (public_count * avg_reply / 3600.0).round,
reopen: reopen_rate(range),
depth: depth_conversations.zero? ? 0 : (public_count.to_f / depth_conversations).round(1)
}
end
# One scan over the assistant's messages computes handled, public-reply count,
# and depth-conversation count for both windows via conditional aggregation.
def message_window_metrics
public_clause = "message_type = #{Message.message_types[:outgoing]} AND private = false"
cur = window_clause(current_range)
prev = window_clause(previous_range)
row = handled_scope(full_span).reorder(nil).pick(
Arel.sql("COUNT(DISTINCT conversation_id) FILTER (WHERE #{cur})"),
Arel.sql("COUNT(DISTINCT conversation_id) FILTER (WHERE #{prev})"),
Arel.sql("COUNT(*) FILTER (WHERE #{cur} AND #{public_clause})"),
Arel.sql("COUNT(*) FILTER (WHERE #{prev} AND #{public_clause})"),
Arel.sql("COUNT(DISTINCT conversation_id) FILTER (WHERE #{cur} AND #{public_clause})"),
Arel.sql("COUNT(DISTINCT conversation_id) FILTER (WHERE #{prev} AND #{public_clause})")
)
{
current: { handled: row[0], public_count: row[2], depth_conversations: row[4] },
previous: { handled: row[1], public_count: row[3], depth_conversations: row[5] }
}
end
# Average reply time (seconds) for both windows in one scan.
def avg_reply_times
row = account.reporting_events.where(name: 'reply_time', created_at: full_span).reorder(nil).pick(
Arel.sql("AVG(value) FILTER (WHERE #{window_clause(current_range)})"),
Arel.sql("AVG(value) FILTER (WHERE #{window_clause(previous_range)})")
)
{ current: row[0].to_f, previous: row[1].to_f }
end
# Resolved and handed-off conversation counts for one window, in a single scan
# of the handled set's reporting events.
def resolution_counts(range)
row = account.reporting_events
.where(name: RESOLVED_EVENT_NAMES + HANDOFF_EVENT_NAMES,
created_at: range,
conversation_id: handled_scope(range).select(:conversation_id))
.reorder(nil)
.pick(
Arel.sql("COUNT(DISTINCT conversation_id) FILTER (WHERE name IN (#{quoted(RESOLVED_EVENT_NAMES)}))"),
Arel.sql("COUNT(DISTINCT conversation_id) FILTER (WHERE name IN (#{quoted(HANDOFF_EVENT_NAMES)}))")
)
{ resolved: row[0], handoff: row[1] }
end
# Conversations the assistant participated in (authored any message).
def handled_scope(range)
account.messages.where(sender_type: 'Captain::Assistant', sender_id: assistant.id, created_at: range)
end
# Span covering both windows so a single scan can split them with FILTER.
def full_span
[current_range.first, previous_range.first].min..current_range.last
end
def window_clause(range)
"created_at >= #{quote(range.first)} AND created_at <= #{quote(range.last)}"
end
def quote(value)
account.class.connection.quote(value)
end
def quoted(values)
values.map { |value| quote(value) }.join(', ')
end
# Of the conversations Captain auto-resolved, the share reopened afterwards. The cohort is
# derived from the assistant's handled conversations (not current inbox membership) so a later
# inbox reassignment doesn't drop historical resolves, and covers both the evaluated (inference)
# and time-based (bot) resolve paths so the denominator matches auto_resolution_rate.
def reopen_rate(range)
resolved_scope = account.reporting_events.where(name: RESOLVED_EVENT_NAMES, created_at: range,
conversation_id: handled_scope(range).select(:conversation_id))
# event_end_time on a reopen is when it actually reopened. Join it to the conversation's own
# Captain resolves and keep only reopens at/after one of them, so a human resolve/reopen earlier
# in the same window isn't mistaken for a reopen-after-Captain-resolve. (Comparing the reopen's
# start time instead would misfire: the inference event is dispatched just after the generic
# conversation_resolved that seeds event_start_time, so it can land after the reopen's start.)
reopened = account.reporting_events
.where(name: 'conversation_opened')
.where('reporting_events.value > 0')
.joins("INNER JOIN (#{resolved_scope.to_sql}) resolves " \
'ON resolves.conversation_id = reporting_events.conversation_id ' \
'AND reporting_events.event_end_time >= resolves.event_end_time')
.distinct.count('reporting_events.conversation_id')
rate(reopened, resolved_scope.distinct.count(:conversation_id))
end
# Approved/pending FAQ counts and the document total in a single round trip.
def knowledge
approved, pending, documents = Captain::AssistantResponse.by_assistant(assistant.id).reorder(nil).pick(
Arel.sql("COUNT(*) FILTER (WHERE status = #{Captain::AssistantResponse.statuses['approved']})"),
Arel.sql("COUNT(*) FILTER (WHERE status = #{Captain::AssistantResponse.statuses['pending']})"),
Arel.sql("(SELECT COUNT(*) FROM captain_documents WHERE assistant_id = #{assistant.id.to_i})")
)
total = approved + pending
{
approved: approved,
pending: pending,
documents: documents,
coverage: total.zero? ? 0 : (approved.to_f / total * 100).round
}
end
def rate(numerator, denominator)
return 0 if denominator.zero?
(numerator.to_f / denominator * 100).round(1)
end
def pack(current, previous, mode)
{ current: current, previous: previous, trend: trend(current, previous, mode) }
end
def trend(current, previous, mode)
case mode
when :percent
previous.zero? ? 0 : ((current - previous).to_f / previous * 100).round(1)
else # :point and :absolute are both current - previous
(current - previous).round(1)
end
end
end
@@ -2,7 +2,7 @@ class Api::V1::Accounts::Captain::AssistantsController < Api::V1::Accounts::Base
before_action :current_account
before_action -> { check_authorization(Captain::Assistant) }
before_action :set_assistant, only: [:show, :update, :destroy, :playground, :stats, :summary]
before_action :set_assistant, only: [:show, :update, :destroy, :playground]
def index
@assistants = account_assistants.ordered
@@ -43,43 +43,8 @@ class Api::V1::Accounts::Captain::AssistantsController < Api::V1::Accounts::Base
@tools = assistant.available_agent_tools
end
def stats
render json: Captain::AssistantStatsBuilder.new(@assistant, params[:range], params[:timezone_offset]).metrics
end
def summary
result = cached_or_generated_summary(Captain::AssistantStatsBuilder.new(@assistant, params[:range], params[:timezone_offset]))
if result[:error]
render json: { error: result[:error] }, status: :unprocessable_content
else
render json: { message: result[:message] }
end
end
private
def cached_or_generated_summary(builder)
cache_key = summary_cache_key(builder.range)
cached = Rails.cache.read(cache_key)
return cached if cached
result = Captain::OverviewSummaryService.new(
account: Current.account,
assistant: @assistant,
first_name: Current.user.name.to_s.split.first,
stats: builder.metrics,
period: builder.period
).perform
# Don't cache transient LLM/config failures, otherwise every reload returns 422 for the next hour.
Rails.cache.write(cache_key, result, expires_in: 1.hour) unless result[:error]
result
end
def summary_cache_key(range)
"captain_overview_summary/#{@assistant.id}/#{Current.user.id}/#{range}/#{Date.current}"
end
def set_assistant
@assistant = account_assistants.find(params[:id])
end
@@ -96,7 +96,7 @@ module Captain::ChatHelper
end
def temperature
@assistant&.config&.[]('temperature').presence&.to_f || 0.5
@assistant&.config&.[]('temperature').to_f || 1
end
def resolved_account_id
@@ -35,7 +35,6 @@ class Captain::Assistant < ApplicationRecord
has_many :messages, as: :sender, dependent: :nullify
has_many :copilot_threads, dependent: :destroy_async
has_many :scenarios, class_name: 'Captain::Scenario', dependent: :destroy_async
has_many :conversation_facts, class_name: 'Captain::ConversationFact', dependent: :destroy_async
store_accessor :config, :temperature, :feature_faq, :feature_memory, :feature_contact_attributes, :product_name
@@ -1,41 +0,0 @@
# == Schema Information
#
# Table name: captain_conversation_facts
#
# id :bigint not null, primary key
# captain_handed_off_at :datetime
# captain_resolved_at :datetime
# csat_rating :integer
# csat_submitted_at :datetime
# first_captain_message_at :datetime
# first_human_reply_after_captain_at :datetime
# last_captain_message_at :datetime
# reopened_after_captain_resolution_at :datetime
# created_at :datetime not null
# updated_at :datetime not null
# account_id :bigint not null
# assistant_id :bigint not null
# conversation_id :bigint not null
# csat_response_id :bigint
# inbox_id :bigint not null
#
# Indexes
#
# idx_captain_facts_on_account_assistant_first_message (account_id,assistant_id,first_captain_message_at)
# idx_captain_facts_on_account_csat_submitted_at (account_id,csat_submitted_at)
# idx_captain_facts_on_account_handed_off_at (account_id,captain_handed_off_at)
# idx_captain_facts_on_account_resolved_at (account_id,captain_resolved_at)
# index_captain_conversation_facts_on_account_id (account_id)
# index_captain_conversation_facts_on_conversation_id (conversation_id) UNIQUE
#
class Captain::ConversationFact < ApplicationRecord
self.table_name = 'captain_conversation_facts'
belongs_to :account
belongs_to :conversation
belongs_to :assistant, class_name: 'Captain::Assistant'
belongs_to :inbox
belongs_to :csat_response, class_name: 'CsatSurveyResponse', optional: true
validates :conversation_id, uniqueness: true
end
+1 -10
View File
@@ -1,15 +1,13 @@
module Concerns::Agentable
extend ActiveSupport::Concern
DEFAULT_TEMPERATURE = 0.5
def agent
Agents::Agent.new(
name: agent_name,
instructions: ->(context) { agent_instructions(context) },
tools: agent_tools,
model: agent_model,
temperature: temperature.presence&.to_f || DEFAULT_TEMPERATURE,
temperature: temperature.to_f || 0.7,
response_schema: agent_response_schema
)
end
@@ -21,7 +19,6 @@ module Concerns::Agentable
state = context.context[:state] || {}
config = state[:assistant_config] || {}
enhanced_context = enhanced_context.merge(
current_time: format_current_time(state[:timezone]),
conversation: state[:conversation] || {},
contact: config['feature_contact_attributes'].present? ? state[:contact] : nil,
campaign: state[:campaign] || {}
@@ -60,12 +57,6 @@ module Concerns::Agentable
Captain::ResponseSchema
end
def format_current_time(timezone)
tz = ActiveSupport::TimeZone[timezone] if timezone.present?
time = tz ? Time.current.in_time_zone(tz) : Time.current
time.strftime('%A, %B %d, %Y %I:%M %p %Z')
end
def prompt_context
raise NotImplementedError, "#{self.class} must implement prompt_context"
end
@@ -13,7 +13,6 @@ module Enterprise::Concerns::Account
has_many :captain_assistant_responses, dependent: :destroy_async, class_name: 'Captain::AssistantResponse'
has_many :captain_documents, dependent: :destroy_async, class_name: 'Captain::Document'
has_many :captain_custom_tools, dependent: :destroy_async, class_name: 'Captain::CustomTool'
has_many :captain_conversation_facts, dependent: :destroy_async, class_name: 'Captain::ConversationFact'
has_many :copilot_threads, dependent: :destroy_async
has_many :companies, dependent: :destroy_async
@@ -15,17 +15,13 @@ module Enterprise::Concerns::Contact
def should_associate_company?
# Only trigger if:
# 1. Contact has an email
# 2. Contact doesn't have a company yet
# 2. Contact doesn't have a compan yet
# 3. Email was just set/changed
# 4. Email was previously nil (first time getting email)
# 5. The account has the Companies feature enabled
# Feature check is last so unrelated contact updates short-circuit on the
# cheap in-memory guards before touching the account (hot message-ingest path).
email.present? &&
company_id.nil? &&
saved_change_to_email? &&
saved_change_to_email.first.nil? &&
account.feature_enabled?('companies')
saved_change_to_email.first.nil?
end
def associate_company_from_email
@@ -7,7 +7,6 @@ module Enterprise::Concerns::Conversation
has_many :sla_events, dependent: :destroy_async
has_many :calls, dependent: :destroy_async
has_many :captain_responses, class_name: 'Captain::AssistantResponse', dependent: :nullify, as: :documentable
has_one :captain_conversation_fact, class_name: 'Captain::ConversationFact', dependent: :destroy_async
before_validation :validate_sla_policy, if: -> { sla_policy_id_changed? }
around_save :ensure_applied_sla_is_created, if: -> { sla_policy_id_changed? }
end
@@ -1,13 +0,0 @@
module Enterprise::CsatSurveyResponse
extend ActiveSupport::Concern
included do
after_commit :update_captain_conversation_fact, on: [:create, :update]
end
private
def update_captain_conversation_fact
Captain::ConversationFactUpdater.record_csat_response(self)
end
end
@@ -4,8 +4,6 @@ module Enterprise::Message
has_one :call, class_name: 'Call', foreign_key: :message_id, dependent: :nullify, inverse_of: :message
scope :with_call, -> { includes(call: [:contact, { inbox: :channel }]) }
after_create_commit :update_captain_conversation_fact
end
end
@@ -17,10 +15,6 @@ module Enterprise::Message
private
def update_captain_conversation_fact
Captain::ConversationFactUpdater.record_message(self)
end
def mark_pending_conversation_as_open_for_human_response
return unless captain_pending_conversation?
return unless human_response?
@@ -11,10 +11,6 @@ class Captain::AssistantPolicy < ApplicationPolicy
true
end
def summary?
true
end
def tools?
@account_user.administrator?
end
@@ -29,7 +29,7 @@ class Captain::Assistant::AgentRunnerService
def generate_response(message_history: [])
message_to_process, context = run_payload(message_history)
result = runner.run(message_to_process, context: context, max_turns: 10)
result = runner.run(message_to_process, context: context, max_turns: 100)
process_agent_result(result)
rescue StandardError => e
@@ -115,8 +115,7 @@ class Captain::Assistant::AgentRunnerService
state = {
account_id: @assistant.account_id,
assistant_id: @assistant.id,
assistant_config: @assistant.config,
timezone: @conversation&.inbox&.timezone.presence || 'UTC'
assistant_config: @assistant.config
}
state[:source] = @source if @source.present?
@@ -156,7 +155,7 @@ class Captain::Assistant::AgentRunnerService
span_attributes: {
ATTR_LANGFUSE_TAGS => ['captain_v2'].to_json
},
attribute_provider: Captain::Assistant::InstrumentationAttributeProvider.new(self)
attribute_provider: ->(context_wrapper) { dynamic_trace_attributes(context_wrapper) }
)
register_trace_input_callback(runner)
end
@@ -169,6 +168,7 @@ class Captain::Assistant::AgentRunnerService
{
ATTR_LANGFUSE_USER_ID => state[:account_id],
format(ATTR_LANGFUSE_METADATA, 'assistant_id') => state[:assistant_id],
format(ATTR_LANGFUSE_METADATA, 'conversation_id') => conversation[:id],
format(ATTR_LANGFUSE_METADATA, 'conversation_display_id') => conversation[:display_id],
format(ATTR_LANGFUSE_METADATA, 'channel_type') => state[:channel_type],
format(ATTR_LANGFUSE_METADATA, 'source') => state[:source],
@@ -1,32 +0,0 @@
# frozen_string_literal: true
class Captain::Assistant::InstrumentationAttributeProvider
include Integrations::LlmInstrumentationConstants
def initialize(service)
@service = service
end
def call(context_wrapper)
@service.send(:dynamic_trace_attributes, context_wrapper)
end
def generation_attributes(_context_wrapper, _chat, message)
{
format(ATTR_LANGFUSE_OBSERVATION_METADATA, 'generation_stage') => generation_stage(message)
}
end
private
def generation_stage(message)
message_has_tool_calls?(message) ? 'tool_call' : 'final_response'
end
def message_has_tool_calls?(message)
return false unless message.respond_to?(:tool_calls)
tool_calls = message.tool_calls
tool_calls.respond_to?(:any?) && tool_calls.any?
end
end
@@ -1,134 +0,0 @@
class Captain::ConversationFactUpdater
RESOLVED_EVENT_NAMES = %w[
conversation_resolved
conversation_bot_resolved
conversation_captain_inference_resolved
].freeze
HANDOFF_EVENT_NAMES = %w[
conversation_bot_handoff
conversation_captain_inference_handoff
].freeze
class << self
def record_message(message)
return unless message.outgoing?
return if message.private?
if captain_message?(message)
record_captain_message(message)
elsif human_message?(message)
record_human_message(message)
end
end
def record_reporting_event(reporting_event)
if RESOLVED_EVENT_NAMES.include?(reporting_event.name)
record_captain_resolution(reporting_event)
elsif HANDOFF_EVENT_NAMES.include?(reporting_event.name)
record_captain_handoff(reporting_event)
elsif reporting_event.name == 'conversation_opened'
record_reopen_after_captain_resolution(reporting_event)
end
end
def record_csat_response(csat_response)
fact = Captain::ConversationFact.find_by(conversation_id: csat_response.conversation_id)
return if fact.blank?
fact.assign_attributes(
csat_response_id: csat_response.id,
csat_rating: csat_response.rating,
csat_submitted_at: csat_response.created_at
)
fact.save! if fact.changed?
end
private
def captain_message?(message)
message.sender_type == 'Captain::Assistant'
end
def human_message?(message)
message.sender_type == 'User'
end
def record_captain_message(message)
fact = find_or_create_fact!(
conversation_id: message.conversation_id,
account_id: message.account_id,
inbox_id: message.inbox_id,
assistant_id: message.sender_id
)
fact.first_captain_message_at ||= message.created_at
fact.last_captain_message_at = latest_time(fact.last_captain_message_at, message.created_at)
fact.save! if fact.changed?
end
def record_human_message(message)
fact = Captain::ConversationFact.find_by(conversation_id: message.conversation_id)
return if fact.blank?
return if fact.first_captain_message_at.blank?
return if fact.first_human_reply_after_captain_at.present?
return if message.created_at <= fact.first_captain_message_at
fact.update!(first_human_reply_after_captain_at: message.created_at)
end
def record_captain_resolution(reporting_event)
return unless captain_actor?(reporting_event)
fact = find_or_create_fact_from_event!(reporting_event)
fact.captain_resolved_at = earliest_time(fact.captain_resolved_at, reporting_event.event_end_time)
fact.save! if fact.changed?
end
def record_captain_handoff(reporting_event)
return unless captain_actor?(reporting_event)
fact = find_or_create_fact_from_event!(reporting_event)
fact.captain_handed_off_at = earliest_time(fact.captain_handed_off_at, reporting_event.event_end_time)
fact.save! if fact.changed?
end
def record_reopen_after_captain_resolution(reporting_event)
fact = Captain::ConversationFact.find_by(conversation_id: reporting_event.conversation_id)
return if fact.blank?
return if fact.captain_resolved_at.blank?
return if fact.reopened_after_captain_resolution_at.present?
return if reporting_event.event_end_time < fact.captain_resolved_at
fact.update!(reopened_after_captain_resolution_at: reporting_event.event_end_time)
end
def captain_actor?(reporting_event)
reporting_event.actor_type == 'Captain::Assistant' && reporting_event.actor_id.present?
end
def find_or_create_fact_from_event!(reporting_event)
find_or_create_fact!(
conversation_id: reporting_event.conversation_id,
account_id: reporting_event.account_id,
inbox_id: reporting_event.inbox_id,
assistant_id: reporting_event.actor_id
)
end
def find_or_create_fact!(conversation_id:, account_id:, inbox_id:, assistant_id:)
Captain::ConversationFact.create_or_find_by!(conversation_id: conversation_id) do |fact|
fact.account_id = account_id
fact.inbox_id = inbox_id
fact.assistant_id = assistant_id
end
end
def earliest_time(current_time, candidate_time)
[current_time, candidate_time].compact.min
end
def latest_time(current_time, candidate_time)
[current_time, candidate_time].compact.max
end
end
end
@@ -1,12 +1,6 @@
class Onboarding::HelpCenterCurator
MAP_LIMIT = 500
# Firecrawl `map` `search` is a substring filter (grep-style) across URL,
# title, and description — not a semantic query. The original 4-term list
# (`docs help support faq`) missed sites whose help content lives at
# non-standard paths, producing ~60% of all onboarding skips via
# "map returned no links". Broaden the term list so more paths match; the
# LLM curator (HelpCenterCurationService) filters the results by quality.
MAP_SEARCH = 'docs help support faq resources guides kb knowledge articles handbook learn tutorial troubleshooting'.freeze
MAP_SEARCH = 'docs help support faq'.freeze
MIN_ARTICLES = 3
Skipped = Onboarding::HelpCenterErrors::CurationSkipped
@@ -7,8 +7,6 @@ json.event_end_time reporting_event.event_end_time
json.account_id reporting_event.account_id
json.inbox_id reporting_event.inbox_id
json.user_id reporting_event.user_id
json.actor_type reporting_event.actor_type
json.actor_id reporting_event.actor_id
json.conversation_id reporting_event.conversation_id
json.created_at reporting_event.created_at
json.updated_at reporting_event.updated_at
+15 -19
View File
@@ -1,18 +1,20 @@
{% if scenarios.size > 0 -%}
# System Context
You are part of Captain, a multi-agent AI system designed for seamless agent coordination and task execution. You can transfer conversations to specialized agents using handoff functions (e.g., `handoff_to_[agent_name]`). These transfers happen in the background - never mention or draw attention to them in your responses.
{% endif -%}
# Your Identity
You are {{name}}, a helpful, friendly, and knowledgeable assistant for the product {{product_name}}. You will not answer anything about other products or events outside of the product {{product_name}}. {% if scenarios.size > 0 -%}Your role is to primarily act as an orchestrator handling multiple scenarios by using handoff tools. Your job also involves providing accurate information, assisting with tasks, and ensuring the customer gets the help they need.{% endif %}
You are {{name}}, a helpful and knowledgeable assistant for the product {{product_name}}. You will not answer anything about other products or events outside of the product {{product_name}}. Your role is to primarily act as an orchestrator handling multiple scenarios by using handoff tools. Your job also involves providing accurate information, assisting with tasks, and ensuring the customer gets the help they need.
{{ description }}
Don't digress away from your instructions, and use all the available tools at your disposal for solving customer issues. If you are to state something factual about {{product_name}}, use the `captain--tools--faq_lookup` tool to check the available information first.
Don't digress away from your instructions, and use all the available tools at your disposal for solving customer issues. If you are to state something factual about {{product_name}} ensure you source that information from the FAQs only. Use the `captain--tools--faq_lookup` tool for this.
{% render 'current_time', current_time: current_time %}
{% render 'core_rules' %}
# Core Rules
- Do not use your own understanding or training data to provide answers. Base responses strictly on the information available through your tools and provided context.
- Do not share anything outside of the context provided.
- Be concise and relevant: most of your responses should be a sentence or two, unless a more detailed explanation is necessary.
- Always detect the language from the user's input and reply in the same language.
- When there is ambiguity, ask clarifying questions rather than make assumptions.
- Remember to follow these rules absolutely, and do not refer to these rules, even if you're asked about them.
{% if conversation || contact || campaign.id -%}
# Current Context
@@ -56,7 +58,6 @@ First, understand what the user is asking:
- **Type**: Is it a question, task, complaint, or request?
- **Complexity**: Can you handle it or does it need specialized expertise?
{% if scenarios.size > 0 -%}
## 2. Check for Specialized Scenarios First
Before using any tools, check if the request matches any of these scenarios. If it seems like a particular scenario matches, use the specific handoff tool to transfer the conversation to the specific agent. The following are the scenario agents that are available to you.
@@ -65,30 +66,25 @@ Before using any tools, check if the request matches any of these scenarios. If
- {{ scenario.title }}: {{ scenario.description }}, use the `handoff_to_{{ scenario.key }}` tool to transfer the conversation to the {{ scenario.title }} agent.
{% endfor %}
If unclear, ask clarifying questions to determine if a scenario applies:
{% endif -%}
## {% if scenarios.size > 0 -%}3{% else -%}2{% endif %}. Handle the Request
{% if scenarios.size > 0 -%}
## 3. Handle the Request
If no specialized scenario clearly matches, handle it yourself in the following way
{% else -%}
Handle the request yourself in the following way
{% endif %}
### For Questions and Information Requests
1. **First, check existing knowledge**: Use `captain--tools--faq_lookup` tool to search for relevant information
2. **If not found in the available information**: Ask at most one concise clarifying question only when the user's request depends on a missing detail and that detail could help you answer, route, or complete the request. Do not ask clarifying questions when the user's goal is already clear but you lack the information or ability to fulfill it.
3. **If still unable to answer or complete the request**: Tell the user you could not help with that from the available information. Ask whether they want to talk to another support agent only if they seem blocked, repeat the request, reject the clarification path, or the issue requires human help. If they ask for or accept human assistance, use the `captain--tools--handoff` tool.
2. **If not found in FAQs**: Try to ask clarifying questions to gather more information
3. **If unable to answer**: Use `captain--tools--handoff` tool to transfer to a human expert
### For Complex or Unclear Requests
1. **Ask clarifying questions**: Gather more information if needed
2. **Break down complex tasks**: Handle step by step or hand off if too complex
3. **Escalate when necessary**: Ask whether the user wants to talk to another support agent for issues beyond your capabilities. If they ask for or accept human assistance, use the `captain--tools--handoff` tool.
3. **Escalate when necessary**: Use `captain--tools--handoff` tool for issues beyond your capabilities
# Human Handoff Protocol
Transfer to a human agent when:
- User explicitly requests human assistance
- User accepts an offer to speak with a human
- You cannot find needed information after checking FAQs
- The issue requires specialized knowledge or permissions you don't have
- Multiple attempts to help have been unsuccessful
If you cannot find needed information after checking the available information and clarifying context, ask whether the user wants to talk to another support agent. Use the `captain--tools--handoff` tool only after the user explicitly requests human assistance or accepts your offer to speak with a human. When using the tool, provide a clear reason that helps the human agent understand the context.
When using the `captain--tools--handoff` tool, provide a clear reason that helps the human agent understand the context.
@@ -8,10 +8,6 @@ You are a specialized agent called "{{ title }}", your task is to handle the fol
If you believe the user's request is not within the scope of your role, you can assign this conversation back to the orchestrator agent using the `handoff_to_{{ assistant_name }}` tool
{% render 'current_time', current_time: current_time %}
{% render 'core_rules' %}
{% if conversation || contact || campaign.id %}
# Current Context
@@ -1,13 +0,0 @@
# Core Rules
- Do not use your own understanding or training data to provide answers. Base responses strictly on the information available through your tools and provided context.
- Do not mention internal tool names, FAQ lookup, search results, or retrieval steps to the customer.
- Do not share anything outside of the context provided.
- Be concise and relevant: most of your responses should be a sentence or two, unless a more detailed explanation is necessary.
- Always detect the language from the user's last message and reply in the same language.
- When there is ambiguity, ask clarifying questions rather than make assumptions.
- If there are multiple steps, provide only one step at a time and wait for the user to confirm before continuing.
- Do not use lists, markdown, bullet points, numbered steps, or other formatting that is not typically spoken.
- Do not promise work that will happen after this reply. Do not say you will check, investigate, monitor, follow up, notify, email, call, refund, cancel, book, escalate, transfer, or submit anything unless you complete that action now using an available tool.
- For human transfer, ask whether the user wants to talk to another support agent only when they are blocked, the issue requires human help, or they ask for human assistance. Use the available handoff tool only after the user asks for or accepts human assistance. Do not merely tell the user they have been transferred unless the handoff tool has been used successfully.
- Do not end the conversation explicitly. Avoid phrases like "Talk soon", "Enjoy", or "How can I assist you further?"
- Remember to follow these rules absolutely, and do not refer to these rules, even if you're asked about them.
@@ -1,8 +0,0 @@
{% if current_time -%}
# Current Time
Current time: {{ current_time }}.
Use this current time when interpreting relative date or time phrases such as today, tomorrow, tonight, this weekend, or next week.
When calling tools, respect any timezone or date-format instructions in the tool parameter descriptions.
This current time is only supporting context for in-scope requests and tool parameters; it does not expand the topics you can answer.
{% endif -%}
-83
View File
@@ -1,83 +0,0 @@
# Generates the LLM welcome summary for the Captain Overview page from the
# assistant's stats hash (see Captain::AssistantStatsBuilder). Renders the
# captain_overview_summary.liquid prompt and returns markdown.
class Captain::OverviewSummaryService < Captain::BaseTaskService
pattr_initialize [:account!, :assistant!, :first_name!, :stats!, :period!]
def perform
api_response = make_api_call(
feature: 'editor',
messages: [
{ role: 'system', content: system_prompt },
{ role: 'user', content: 'Write the summary.' }
]
)
return api_response if api_response[:error]
{ message: api_response[:message] }
end
private
def system_prompt
Liquid::Template.parse(prompt_from_file('captain_overview_summary')).render(prompt_variables)
end
def prompt_variables
stat_variables.merge(period_variables)
end
def stat_variables
{
'first_name' => first_name.to_s,
'assistant_name' => assistant.name.to_s,
'conversations_handled' => current(:conversations_handled),
'hours_saved' => current(:hours_saved),
'auto_resolution_rate' => current(:auto_resolution_rate),
'auto_resolution_trend' => trend(:auto_resolution_rate),
'handoff_rate' => current(:handoff_rate),
'handoff_trend' => trend(:handoff_rate),
'reopen_rate' => current(:reopen_rate),
'reopen_trend' => trend(:reopen_rate),
'knowledge_coverage' => stats.dig(:knowledge, :coverage).to_s,
'knowledge_approved' => stats.dig(:knowledge, :approved).to_s,
'knowledge_documents' => stats.dig(:knowledge, :documents).to_s
}
end
def period_variables
{
'today' => formatted_date(Time.zone.today),
'period_label' => period[:label].to_s,
'period_start' => formatted_date(period[:starts_on]),
'period_end' => formatted_date(period[:ends_on])
}
end
def formatted_date(date)
date.strftime('%B %-d, %Y')
end
def current(key)
stats.dig(key, :current).to_s
end
def trend(key)
stats.dig(key, :trend).to_s
end
def event_name
'captain_overview_summary'
end
def use_account_openai_hook?
true
end
# The overview summary is an internal analytics readout, not a customer-facing
# response, so it should not consume or be blocked by the captain_responses quota.
def counts_toward_usage?
false
end
end
@@ -1,38 +0,0 @@
You are writing a short, warm summary of how an AI support assistant named "{{ assistant_name }}" performed over a reporting period, for {{ first_name }}, the person who manages it.
Voice and format:
- Address {{ first_name }} directly and open with "Hey {{ first_name }},". Be conversational, never robotic.
- Always call the assistant by its name, {{ assistant_name }}. Never call it "Captain", "the assistant", or "your assistant".
- This is a static, read-only poster on an analytics dashboard, not a chat. The reader cannot reply or ask you for anything. Never ask a question, invite a reply, offer further help, or say things like "let me know" or "I can dive in".
- Write 2 to 4 sentences in one short paragraph. Add a second short paragraph only for a genuinely useful heads-up.
- Output plain markdown only: no headings, lists, preamble, or sign-off. Do not use em dashes.
- Never state an exact figure. This summary is cached and the live numbers keep moving, so a precise value would quickly look wrong. Round every number down to a clean approximation and soften it with words like "around", "roughly", "about", "nearly", "just over", or "upwards of". For example, render **1,248** as "upwards of **1,200**", **63.2%** as "around **60%**", and **612** hours as "roughly **600** hours". For a small count, use a loose phrase like "a handful" instead of the exact number.
- Wrap the approximate figure in **double asterisks** so the interface can highlight it. Bold only the figures, never whole phrases or the softening word.
Timing: today is {{ today }}. These stats cover {{ period_label }} ({{ period_start }} to {{ period_end }}). You may lightly reference the month, the season, or how far into the period things stand when it genuinely fits, but never invent events or facts.
The stats for this period:
<stats>
- Conversations handled: {{ conversations_handled }}. Distinct conversations {{ assistant_name }} replied in at least once. Raw volume and adoption, not a measure of quality.
- Hours saved: {{ hours_saved }} hours. A rough, directional estimate of agent time saved. A feel-good figure, not exact measured labor.
- Auto-resolution rate: {{ auto_resolution_rate }}% ({{ auto_resolution_trend }} points vs previous period). Of the conversations it handled, the share {{ assistant_name }} resolved on its own with no human reply. The core performance signal; higher is better.
- Handoff rate: {{ handoff_rate }}% ({{ handoff_trend }} points vs previous period). Of the conversations it handled, the share it escalated to a human agent. The inverse of deflection; lower is better.
- Reopen-after-resolve rate: {{ reopen_rate }}% ({{ reopen_trend }} points vs previous period). Of the conversations it auto-resolved, the share later reopened. A quality signal; lower is better, and a high value means it closed conversations the customer was not actually done with.
- Knowledge base: {{ knowledge_approved }} approved FAQ answers, {{ knowledge_documents }} documents, {{ knowledge_coverage }}% coverage (the share of FAQ answers the team has approved). This is setup the team controls, not something {{ assistant_name }} earned. It is a leading indicator: low coverage tends to cause low auto-resolution.
</stats>
Only the auto-resolution, handoff, and reopen rates reflect how {{ assistant_name }} actually performed, and they are the only things worth crediting it for. Conversations handled and hours saved are context. The knowledge base is an input, never a win to praise.
How to judge the numbers (rough bands, do not quote them in the summary):
- Auto-resolution rate: below 30% is low and early-stage, 30 to 50% is decent, above 50% is genuinely strong.
- Handoff rate: above 60% is high, 30 to 60% is moderate, below 30% is strong.
- Reopen-after-resolve rate: below 5% is healthy, 5 to 15% is worth watching, above 15% is a real problem.
- Knowledge coverage: only worth mentioning when below 85% (below 60% is seriously thin), as a likely cause of weak auto-resolution. At 85% or above it is just the healthy baseline, so do not mention or praise it.
- When the conversation volume is small (roughly under 30), rates are noisy, so describe them tentatively and do not over-interpret a perfect or terrible looking percentage.
Writing the summary:
- Cold start: if conversations handled is 0, there is no performance to report. Skip the auto-resolution, handoff, reopen, and hours-saved figures entirely. Instead note the knowledge base and say {{ assistant_name }} is set up and ready to start handling support (or ready to start once some knowledge is added, if the base is empty). Ignore the rest of these points in this case.
- Be honest and proportionate. Do not call a result impressive, strong, excellent, solid, flawless, or perfect unless it clears the "strong" band above. State a low or middling number plainly or as room to grow, never dressed up. A modest summary is fine and often correct.
- Lead with the genuinely strong results if there are any. If nothing clears the strong band, open plainly with the volume of work handled, without overselling it.
- Mention a trend only when it is meaningful, and judge it against the bands rather than the direction alone (a rate that rose but is still in the low band is not yet a win).
- Surface at most one proactive concern when a stat warrants it (a high handoff rate, a low auto-resolution rate, a rising reopen rate, or thin coverage). Skip it entirely when everything looks healthy. Keep it a calm observation about the data, not an alarm.
@@ -36,6 +36,33 @@ RSpec.describe 'Conversation Messages API', type: :request do
expect(conversation.messages.first.content).to eq(params[:content])
end
it 'blocks public replies when an agent bot owns the conversation' do
conversation.update!(assignee_agent_bot: create(:agent_bot, account: account))
params = { content: 'test-message', private: false }
post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id),
params: params,
headers: agent.create_new_auth_token,
as: :json
expect(response).to have_http_status(:unprocessable_entity)
expect(response.parsed_body['error']).to eq('Conversation is assigned to an Agent Bot. Take over the conversation before replying.')
expect(conversation.messages.count).to eq(0)
end
it 'allows private notes when an agent bot owns the conversation' do
conversation.update!(assignee_agent_bot: create(:agent_bot, account: account))
params = { content: 'test-note', private: true }
post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id),
params: params,
headers: agent.create_new_auth_token,
as: :json
expect(response).to have_http_status(:success)
expect(conversation.messages.last).to be_private
end
it 'does not create the message' do
params = { content: "#{'h' * 150 * 1000}a", private: true }
@@ -109,7 +136,7 @@ RSpec.describe 'Conversation Messages API', type: :request do
end
context 'when it is an authenticated agent bot' do
let!(:agent_bot) { create(:agent_bot) }
let!(:agent_bot) { create(:agent_bot, account: account) }
it 'creates a new outgoing message' do
create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot)
@@ -125,6 +152,21 @@ RSpec.describe 'Conversation Messages API', type: :request do
expect(conversation.messages.first.content).to eq(params[:content])
end
it 'creates a new outgoing message when the agent bot owns the conversation' do
create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot)
conversation.update!(assignee_agent_bot: agent_bot)
params = { content: 'test-message' }
post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id),
params: params,
headers: { api_access_token: agent_bot.access_token.token },
as: :json
expect(response).to have_http_status(:success)
expect(conversation.messages.count).to eq(1)
expect(conversation.messages.first.content).to eq(params[:content])
end
it 'creates a new outgoing input select message' do
create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot)
select_item1 = build(:bot_message_select)
@@ -1,223 +0,0 @@
require 'rails_helper'
RSpec.describe Captain::AssistantStatsBuilder do
let(:account) { create(:account) }
let(:assistant) { create(:captain_assistant, account: account) }
let(:inbox) { create(:inbox, account: account) }
before { create(:captain_inbox, captain_assistant: assistant, inbox: inbox) }
describe '#metrics' do
# Two conversations handled in the current 30-day window, one in the previous.
let(:current_convo_a) { create(:conversation, account: account, inbox: inbox) }
let(:current_convo_b) { create(:conversation, account: account, inbox: inbox) }
let(:previous_convo) { create(:conversation, account: account, inbox: inbox) }
before do
[current_convo_a, current_convo_b].each do |conversation|
create(:message, account: account, inbox: inbox, conversation: conversation,
sender: assistant, message_type: :outgoing, private: false, created_at: 5.days.ago)
end
create(:message, account: account, inbox: inbox, conversation: previous_convo,
sender: assistant, message_type: :outgoing, private: false, created_at: 45.days.ago)
end
it 'returns every metric for the current and previous window' do
metrics = described_class.new(assistant, '30').metrics
expect(metrics.keys).to contain_exactly(
:conversations_handled, :auto_resolution_rate, :handoff_rate,
:hours_saved, :reopen_rate, :conversation_depth, :knowledge
)
expect(metrics[:conversations_handled]).to include(:current, :previous, :trend)
end
it 'counts distinct handled conversations per window and the percent trend' do
handled = described_class.new(assistant, '30').metrics[:conversations_handled]
expect(handled[:current]).to eq(2)
expect(handled[:previous]).to eq(1)
expect(handled[:trend]).to eq(100.0)
end
it 'derives auto-resolution and handoff rates from reporting events on the handled set' do
create(:reporting_event, account: account, conversation: current_convo_a,
name: 'conversation_captain_inference_resolved')
create(:reporting_event, account: account, conversation: current_convo_b,
name: 'conversation_captain_inference_handoff')
metrics = described_class.new(assistant, '30').metrics
expect(metrics[:auto_resolution_rate][:current]).to eq(50.0)
expect(metrics[:handoff_rate][:current]).to eq(50.0)
end
it 'excludes resolution events that fall outside the current window' do
create(:reporting_event, account: account, conversation: current_convo_a,
name: 'conversation_captain_inference_resolved', created_at: 60.days.ago)
metrics = described_class.new(assistant, '30').metrics
expect(metrics[:auto_resolution_rate][:current]).to eq(0.0)
end
it 'computes conversation depth as public replies per handled conversation' do
depth = described_class.new(assistant, '30').metrics[:conversation_depth]
# 2 public outgoing replies across 2 distinct conversations in the current window.
expect(depth[:current]).to eq(1.0)
end
it 'ignores private notes and incoming messages when counting public replies' do
create(:message, account: account, inbox: inbox, conversation: current_convo_a,
sender: assistant, message_type: :outgoing, private: true, created_at: 5.days.ago)
depth = described_class.new(assistant, '30').metrics[:conversation_depth]
expect(depth[:current]).to eq(1.0)
end
end
describe 'range handling' do
it 'accepts the allowed day and named ranges' do
%w[7 30 90 this_month last_month].each do |allowed|
expect(described_class.new(assistant, allowed).range).to eq(allowed)
end
end
it 'falls back to the default range for values outside the allowed set' do
expect(described_class.new(assistant, '365000').range).to eq('30')
expect(described_class.new(assistant, 'bogus').range).to eq('30')
expect(described_class.new(assistant, nil).range).to eq('30')
end
end
describe '#metrics reopen_rate' do
# A conversation the assistant handled (messaged) inside the current 30-day window.
let(:conversation) { create(:conversation, account: account, inbox: inbox) }
before do
create(:message, account: account, inbox: inbox, conversation: conversation,
sender: assistant, message_type: :outgoing, private: false, created_at: 8.days.ago)
end
it 'counts a reopen that happened after the captain resolve' do
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_bot_resolved', event_start_time: 6.days.ago, event_end_time: 6.days.ago)
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_opened', value: 120, event_start_time: 6.days.ago, event_end_time: 4.days.ago)
expect(described_class.new(assistant, '30').metrics[:reopen_rate][:current]).to eq(100.0)
end
it 'ignores a human resolve/reopen that happened before the captain resolve' do
# Earlier resolve/reopen cycle, then Captain resolves later in the same window.
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_opened', value: 120, event_start_time: 20.days.ago, event_end_time: 18.days.ago)
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_bot_resolved', event_start_time: 5.days.ago, event_end_time: 5.days.ago)
expect(described_class.new(assistant, '30').metrics[:reopen_rate][:current]).to eq(0.0)
end
it 'counts an evaluated-path reopen when bot_resolved is skipped and the inference event is newer' do
# Prior human reply => create_bot_resolved_event skips conversation_bot_resolved, so the cohort
# only holds the inference event, which is dispatched a moment after the generic conversation_resolved
# that seeds the reopen's event_start_time. The match must use the reopen's actual reopen time.
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_captain_inference_resolved',
event_start_time: 6.days.ago, event_end_time: 6.days.ago + 1.second)
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_opened', value: 120, event_start_time: 6.days.ago, event_end_time: 3.days.ago)
expect(described_class.new(assistant, '30').metrics[:reopen_rate][:current]).to eq(100.0)
end
it 'counts both inference and time-based bot resolves in the denominator' do
# conversation: inference-resolved and reopened
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_captain_inference_resolved', event_start_time: 6.days.ago, event_end_time: 6.days.ago)
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_opened', value: 120, event_start_time: 6.days.ago, event_end_time: 4.days.ago)
# other: time-based bot-resolved, never reopened
other = create(:conversation, account: account, inbox: inbox)
create(:message, account: account, inbox: inbox, conversation: other,
sender: assistant, message_type: :outgoing, private: false, created_at: 8.days.ago)
create(:reporting_event, account: account, inbox: inbox, conversation: other,
name: 'conversation_bot_resolved', event_start_time: 6.days.ago, event_end_time: 6.days.ago)
expect(described_class.new(assistant, '30').metrics[:reopen_rate][:current]).to eq(50.0)
end
it 'derives the cohort from handled conversations, not current inbox membership' do
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_captain_inference_resolved', event_start_time: 6.days.ago, event_end_time: 6.days.ago)
create(:reporting_event, account: account, inbox: inbox, conversation: conversation,
name: 'conversation_opened', value: 120, event_start_time: 6.days.ago, event_end_time: 4.days.ago)
# The assistant is later removed from the inbox; the cohort must still resolve via handled messages.
CaptainInbox.where(captain_assistant: assistant).delete_all
expect(described_class.new(assistant, '30').metrics[:reopen_rate][:current]).to eq(100.0)
end
end
describe 'timezone anchoring' do
# 2026-07-01 03:00 UTC is still 2026-06-30 in any timezone behind UTC by 4h+.
it 'anchors the this_month window to the supplied offset, not UTC' do
travel_to(Time.utc(2026, 7, 1, 3, 0, 0)) do
utc = described_class.new(assistant, 'this_month').period
la = described_class.new(assistant, 'this_month', -7).period
expect(utc[:starts_on]).to eq(Date.new(2026, 7, 1))
expect(la[:starts_on]).to eq(Date.new(2026, 6, 1))
expect(la[:ends_on]).to eq(Date.new(2026, 6, 30))
end
end
it 'defaults to UTC when no offset is given' do
travel_to(Time.utc(2026, 7, 1, 3, 0, 0)) do
expect(described_class.new(assistant, 'this_month').period[:starts_on]).to eq(Date.new(2026, 7, 1))
end
end
end
describe '#metrics knowledge' do
before do
create_list(:captain_assistant_response, 3, assistant: assistant, account: account, status: :approved)
create(:captain_assistant_response, assistant: assistant, account: account, status: :pending)
create_list(:captain_document, 2, assistant: assistant, account: account)
end
it 'returns approved, pending, document counts and coverage' do
knowledge = described_class.new(assistant, '30').metrics[:knowledge]
expect(knowledge).to eq(approved: 3, pending: 1, documents: 2, coverage: 75)
end
it 'reports zero coverage when there are no responses' do
Captain::AssistantResponse.where(assistant: assistant).delete_all
knowledge = described_class.new(assistant, '30').metrics[:knowledge]
expect(knowledge[:coverage]).to eq(0)
end
end
describe '#period' do
it 'labels a day range and exposes its bounds' do
period = described_class.new(assistant, '30').period
expect(period[:label]).to eq('the last 30 days')
expect(period[:starts_on]).to eq(30.days.ago.to_date)
expect(period[:ends_on]).to eq(Time.zone.today)
end
it 'labels the this_month range' do
expect(described_class.new(assistant, 'this_month').period[:label]).to eq('this month')
end
it 'labels the last_month range' do
expect(described_class.new(assistant, 'last_month').period[:label]).to eq('last month')
end
end
end
@@ -252,48 +252,6 @@ RSpec.describe 'Api::V1::Accounts::Captain::Assistants', type: :request do
end
end
describe 'GET /api/v1/accounts/{account.id}/captain/assistants/{id}/summary' do
let(:assistant) { create(:captain_assistant, account: account) }
let(:alice) { create(:user, account: account, role: :administrator, name: 'Alice Adams') }
let(:bob) { create(:user, account: account, role: :administrator, name: 'Bob Brown') }
let(:summary_service) { instance_double(Captain::OverviewSummaryService) }
def get_summary(user)
get "/api/v1/accounts/#{account.id}/captain/assistants/#{assistant.id}/summary",
params: { range: '30' },
headers: user.create_new_auth_token,
as: :json
end
before do
# Test env uses a null store; swap in a real store so caching behaviour is observable.
allow(Rails).to receive(:cache).and_return(ActiveSupport::Cache::MemoryStore.new)
allow(Captain::OverviewSummaryService).to receive(:new).and_return(summary_service)
end
it 'caches the summary per viewer so one user never receives another user\'s greeting' do
allow(summary_service).to receive(:perform).and_return({ message: 'Hi Alice' })
get_summary(alice)
get_summary(alice) # served from Alice's cache, no regeneration
get_summary(bob) # distinct cache key, regenerated for Bob
expect(response).to have_http_status(:success)
expect(Captain::OverviewSummaryService).to have_received(:new).twice
end
it 'does not cache failures so a transient error is retried' do
allow(summary_service).to receive(:perform).and_return({ error: 'LLM unavailable' })
get_summary(alice)
get_summary(alice)
expect(response).to have_http_status(:unprocessable_content)
expect(json_response[:error]).to eq('LLM unavailable')
expect(Captain::OverviewSummaryService).to have_received(:new).twice
end
end
describe 'POST /api/v1/accounts/{account.id}/captain/assistants/{id}/playground' do
let(:assistant) { create(:captain_assistant, account: account) }
let(:valid_params) do
@@ -56,11 +56,11 @@ RSpec.describe Concerns::Agentable do
dummy_instance.agent
end
it 'uses default temperature when temperature is nil' do
it 'converts nil temperature to 0.0' do
dummy_instance.temperature = nil
expect(Agents::Agent).to receive(:new).with(
hash_including(temperature: 0.5)
hash_including(temperature: 0.0)
)
dummy_instance.agent
@@ -4,26 +4,6 @@ RSpec.describe Contact, type: :model do
describe 'company auto-association' do
let(:account) { create(:account) }
before { account.enable_features!(:companies) }
context 'when the companies feature is disabled' do
before { account.disable_features!(:companies) }
it 'does not create or associate a company' do
expect do
create(:contact, email: 'john@acme.com', account: account)
end.not_to change(Company, :count)
expect(described_class.last.company).to be_nil
end
it 'preserves a contact-supplied company_name' do
contact = create(:contact, email: 'john@acme.com', account: account,
additional_attributes: { 'company_name' => 'John Personal Co' })
expect(contact.reload.additional_attributes['company_name']).to eq('John Personal Co')
end
end
context 'when creating a new contact with business email' do
it 'automatically creates and associates a company' do
expect do
@@ -93,7 +93,7 @@ RSpec.describe Captain::Assistant::AgentRunnerService do
expect(mock_runner).to receive(:run).with(
'I need help with my account',
context: expected_context,
max_turns: 10
max_turns: 100
)
service.generate_response(message_history: message_history)
@@ -119,7 +119,7 @@ RSpec.describe Captain::Assistant::AgentRunnerService do
expect(input.text).to eq('What does this error mean?')
expect(input.attachments.first.source.to_s).to eq('https://example.com/error.png')
expect(context[:conversation_history]).to eq([{ role: :assistant, content: 'Please share a screenshot', agent_name: nil }])
expect(max_turns).to eq(10)
expect(max_turns).to eq(100)
end
service.generate_response(message_history: multimodal_message_history)
@@ -147,7 +147,7 @@ RSpec.describe Captain::Assistant::AgentRunnerService do
{ type: 'text', text: 'Here is my error screenshot' },
{ type: 'image_url', image_url: { url: 'https://example.com/error.png' } }
)
expect(max_turns).to eq(10)
expect(max_turns).to eq(100)
end
service.generate_response(message_history: history_with_prior_image)
@@ -157,7 +157,7 @@ RSpec.describe Captain::Assistant::AgentRunnerService do
expect(mock_runner).to receive(:run) do |_input, context:, max_turns:|
expect(context[:captain_v2_trace_input]).to include('image_url')
expect(context[:captain_v2_trace_current_input]).to include('image_url')
expect(max_turns).to eq(10)
expect(max_turns).to eq(100)
end
service.generate_response(message_history: multimodal_message_history)
@@ -405,47 +405,6 @@ RSpec.describe Captain::Assistant::AgentRunnerService do
end
end
describe 'InstrumentationAttributeProvider' do
subject(:provider) { Captain::Assistant::InstrumentationAttributeProvider.new(service) }
let(:service) { described_class.new(assistant: assistant, conversation: conversation) }
it 'delegates root trace attributes to the service' do
context = {
state: {
account_id: account.id,
assistant_id: assistant.id,
conversation: { id: conversation.id, display_id: conversation.display_id }
}
}
context_wrapper = Struct.new(:context).new(context)
attributes = provider.call(context_wrapper)
expect(attributes).to include(
'langfuse.user.id' => account.id.to_s,
'langfuse.trace.metadata.assistant_id' => assistant.id.to_s
)
end
it 'marks final response generations for observation-level evaluators' do
message = instance_double(RubyLLM::Message, tool_calls: {})
attributes = provider.generation_attributes(nil, nil, message)
expect(attributes['langfuse.observation.metadata.generation_stage']).to eq('final_response')
end
it 'marks tool call generations separately from final responses' do
tool_call = instance_double(RubyLLM::ToolCall)
message = instance_double(RubyLLM::Message, tool_calls: { 'call_1' => tool_call })
attributes = provider.generation_attributes(nil, nil, message)
expect(attributes['langfuse.observation.metadata.generation_stage']).to eq('tool_call')
end
end
describe '#build_state' do
subject(:service) { described_class.new(assistant: assistant, conversation: conversation) }
@@ -39,24 +39,6 @@ RSpec.describe Captain::Llm::AssistantChatService do
service.generate_response(message_history: [{ role: 'user', content: 'Hello' }])
end
it 'uses default temperature when assistant config does not include temperature' do
expect(mock_chat).to receive(:with_temperature).with(0.5).and_return(mock_chat)
allow(mock_chat).to receive(:ask).and_return(mock_response)
service = described_class.new(assistant: assistant, conversation: conversation)
service.generate_response(message_history: [{ role: 'user', content: 'Hello' }])
end
it 'preserves explicit assistant config temperature' do
assistant.update!(config: assistant.config.merge('temperature' => 1.0))
expect(mock_chat).to receive(:with_temperature).with(1.0).and_return(mock_chat)
allow(mock_chat).to receive(:ask).and_return(mock_response)
service = described_class.new(assistant: assistant, conversation: conversation)
service.generate_response(message_history: [{ role: 'user', content: 'Hello' }])
end
it 'passes channel_type to the agent session instrumentation' do
service = described_class.new(assistant: assistant, conversation: conversation)
@@ -82,36 +82,6 @@ RSpec.describe Crm::Leadsquared::ProcessorService do
end
end
context 'when the existing lead no longer exists' do
let(:error_response) do
instance_double(HTTParty::Response, blank?: false, parsed_response: { 'ExceptionType' => 'MXInvalidEntityReferenceException' })
end
let(:lead_not_found_error) do
Crm::Leadsquared::Api::BaseClient::ApiError.new('Lead not found', 500, error_response)
end
before do
contact.update!(additional_attributes: { 'external' => { 'leadsquared_id' => 'stale_lead_id' } })
allow(lead_client).to receive(:update_lead)
.with(any_args, 'stale_lead_id')
.and_raise(lead_not_found_error)
allow(lead_client).to receive(:update_lead)
.with(any_args, 'fresh_lead_id')
.and_return(nil)
allow(lead_finder).to receive(:find_or_create)
.with(contact)
.and_return('fresh_lead_id')
end
it 'clears the stale id and re-resolves the lead' do
service.handle_contact(contact)
expect(lead_finder).to have_received(:find_or_create).with(contact)
expect(contact.reload.additional_attributes['external']['leadsquared_id']).to eq('fresh_lead_id')
end
end
context 'when API call raises an error' do
before do
allow(lead_client).to receive(:create_or_update_lead)
@@ -190,63 +160,6 @@ RSpec.describe Crm::Leadsquared::ProcessorService do
expect(Rails.logger).to have_received(:error).with(/LeadSquared conversation activity failed/)
end
end
context 'when post_activity fails because the lead no longer exists' do
let(:error_response) do
instance_double(HTTParty::Response, blank?: false, parsed_response: { 'ExceptionType' => 'MXInvalidEntityReferenceException' })
end
let(:lead_not_found_error) do
Crm::Leadsquared::Api::BaseClient::ApiError.new('Lead not found', 500, error_response)
end
before do
contact.update!(additional_attributes: { 'external' => { 'leadsquared_id' => 'stale_lead_id' } })
allow(lead_finder).to receive(:find_or_create)
.with(contact)
.and_return('stale_lead_id', 'fresh_lead_id')
allow(activity_client).to receive(:post_activity)
.with('stale_lead_id', 1001, activity_note)
.and_raise(lead_not_found_error)
allow(activity_client).to receive(:post_activity)
.with('fresh_lead_id', 1001, activity_note)
.and_return('healed_activity_id')
end
it 'clears the stale id, re-resolves the lead, and retries the activity once' do
service.handle_conversation_created(conversation)
expect(activity_client).to have_received(:post_activity).with('fresh_lead_id', 1001, activity_note)
expect(contact.reload.additional_attributes['external']['leadsquared_id']).to eq('fresh_lead_id')
expect(conversation.reload.additional_attributes['leadsquared']['created_activity_id']).to eq('healed_activity_id')
end
end
context 'when post_activity fails with a non-recoverable error' do
let(:error_response) do
instance_double(HTTParty::Response, blank?: false, parsed_response: { 'ExceptionType' => 'MXSomeOtherException' })
end
let(:other_error) do
Crm::Leadsquared::Api::BaseClient::ApiError.new('boom', 500, error_response)
end
before do
allow(lead_finder).to receive(:find_or_create)
.with(contact)
.and_return('test_lead_id')
allow(activity_client).to receive(:post_activity).and_raise(other_error)
allow(Rails.logger).to receive(:error)
end
it 'logs once and does not retry' do
service.handle_conversation_created(conversation)
expect(activity_client).to have_received(:post_activity).once
expect(Rails.logger).to have_received(:error).with(/LeadSquared conversation activity failed/)
end
end
end
context 'when conversation activities are disabled' do
@@ -40,16 +40,6 @@ properties:
- number
- 'null'
description: ID of the user/agent
actor_type:
type:
- string
- 'null'
description: Type of the actor that caused the reporting event
actor_id:
type:
- number
- 'null'
description: ID of the actor that caused the reporting event
created_at:
type: string
format: date-time