Skip to content
This repository was archived by the owner on Mar 26, 2025. It is now read-only.

Commit 852ac49

Browse files
committedOct 16, 2024·
Add AI Safety section to mint.json
1 parent 7ad038a commit 852ac49

7 files changed

+148
-0
lines changed
 

‎docs/images/debug-mode.mp4

1.53 MB
Binary file not shown.

‎docs/images/filter.mp4

1.27 MB
Binary file not shown.

‎docs/images/inspect-mode-message.png

68.6 KB
Loading

‎docs/mint.json

+5
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,11 @@
131131
"icon": "envelope",
132132
"pages": ["api-reference/email/email_api"]
133133
},
134+
{
135+
"group": "AI Safety",
136+
"icon": "shield-check",
137+
"pages": ["safety/introduction", "safety/inspect-mode", "safety/debug-mode"]
138+
},
134139
{
135140
"group": "Resources",
136141
"pages": [

‎docs/safety/debug-mode.mdx

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "Debug Mode"
3+
icon: "circle-info"
4+
description: "Understand why the AI said what it said."
5+
---
6+
7+
When the AI provides an answer, there’s usually a reason behind it. This feature allows you to see the underlying data the AI used to form its response.
8+
9+
## How to use this feature?
10+
11+
<Steps>
12+
<Step title="Filter sessions">
13+
Filter sessions by the AI agent. This will display a list of all ongoing conversations where the AI is active.
14+
<video
15+
autoPlay
16+
muted
17+
loop
18+
playsInline
19+
className="w-full aspect-video rounded-lg"
20+
src="/images/filter.mp4">
21+
</video>
22+
</Step>
23+
<Step title="Click on the debug button">
24+
Clicking this will open a popup showing the data the AI used to answer the question.
25+
<video
26+
autoPlay
27+
muted
28+
loop
29+
playsInline
30+
className="w-full aspect-video rounded-lg"
31+
src="/images/debug-mode.mp4">
32+
</video>
33+
</Step>
34+
<Step title="Actions, Knowledge, and Keywords">
35+
- **Actions**: These represent the steps the AI took to formulate its response.
36+
- **Knowledge**: This shows the data or knowledge the AI relied on to answer the question.
37+
- **Keywords**: These are the search terms or keywords the AI used in its hybrid search process.
38+
</Step>
39+
</Steps>
40+
41+
## How to enable debug mode on the widget?
42+
For development purposes, you can enable debug mode on the widget by passing the `debug` prop to the `initOpenScript` function. This way, the widget will log all the messages and events to the console and to the chat ui (default: false)
43+
44+
45+
Read more <a href="/widget/embed#available-options">here</a>

‎docs/safety/inspect-mode.mdx

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Inspect Mode"
3+
icon: "eye"
4+
description: "See what the AI is doing in real time and intervene if needed."
5+
---
6+
7+
This feature allows human agents to monitor the AI in real time. You can observe the AI’s actions, see what it's doing, and understand its reasoning.
8+
9+
## How to use this feature?
10+
11+
<Steps>
12+
<Step title="Filter sessions">
13+
Filter sessions by the AI agent. This will provide a list of all ongoing conversations where the AI is active.
14+
<video
15+
autoPlay
16+
muted
17+
loop
18+
playsInline
19+
className="w-full aspect-video rounded-lg"
20+
src="/images/filter.mp4">
21+
</video>
22+
</Step>
23+
<Step title="Select a session">
24+
Click on the session you want to inspect. This will open Inspect Mode.
25+
<img src="/images/inspect-mode-message.png" alt="Inspect Mode" className="w-full rounded-lg"/>
26+
</Step>
27+
<Step title="Take over if needed">
28+
If necessary, you can take control of the conversation by typing a message in the chat window. This will pause the AI and let you take over.
29+
</Step>
30+
</Steps>

‎docs/safety/introduction.mdx

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: "Introduction"
3+
icon: "shield-check"
4+
description: "We have gone further than anyone in on the market to make sure that our AI is safe and reliable."
5+
---
6+
We know that AI, in its current form, is still new to the market. We’re constantly working to make sure it’s safe and reliable. That’s why we’ve implemented several measures to ensure the trustworthiness of our AI, giving you confidence when using it.
7+
8+
## Observability & Interpretability
9+
10+
These features are designed to give human agents the ability to see and understand the AI while it’s at work.
11+
12+
<CardGroup cols={2}>
13+
<Card
14+
title="Inspect Mode"
15+
icon="hand-holding-heart"
16+
color="#f7b245"
17+
iconType="solid"
18+
href="/safety/inspect-mode"
19+
>
20+
</Card>
21+
22+
<Card
23+
title="Debug Mode"
24+
icon="gear"
25+
color="#f7b245"
26+
iconType="solid"
27+
href="/safety/debug-mode"
28+
>
29+
</Card>
30+
31+
<Card
32+
title="Human Takeover"
33+
icon="inbox"
34+
color="#f7b245"
35+
iconType="solid"
36+
href="/safety/inspect-mode"
37+
>
38+
</Card>
39+
40+
<Card
41+
title="Handoff"
42+
icon="inbox"
43+
color="#f7b245"
44+
iconType="solid"
45+
href="/resources/human-handoff"
46+
>
47+
</Card>
48+
</CardGroup>
49+
50+
51+
## Assist Mode (formerly Draft Mode)
52+
53+
For heavily regulated industries, we’ve introduced Assist Mode. This feature allows human agents to review the AI’s plan before sending it to the customer. Think of it as a human supervision layer for AI.
54+
55+
<CardGroup cols={2}>
56+
<Card
57+
title="Assist Mode"
58+
icon="hand-holding-heart"
59+
color="#f7b245"
60+
iconType="solid"
61+
href="/resources/assist-mode"
62+
>
63+
</Card>
64+
</CardGroup>
65+
66+
## Compliance
67+
68+
We are in the process of achieving SOC-2 certification, which is expected to be completed by Q4 2024.

0 commit comments

Comments
 (0)
This repository has been archived.