Skip to content

Commit

Permalink
Add AI Safety section to mint.json
Browse files Browse the repository at this point in the history
  • Loading branch information
gharbat committed Oct 16, 2024
1 parent 7ad038a commit 852ac49
Show file tree
Hide file tree
Showing 7 changed files with 148 additions and 0 deletions.
Binary file added docs/images/debug-mode.mp4
Binary file not shown.
Binary file added docs/images/filter.mp4
Binary file not shown.
Binary file added docs/images/inspect-mode-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@
"icon": "envelope",
"pages": ["api-reference/email/email_api"]
},
{
"group": "AI Safety",
"icon": "shield-check",
"pages": ["safety/introduction", "safety/inspect-mode", "safety/debug-mode"]
},
{
"group": "Resources",
"pages": [
Expand Down
45 changes: 45 additions & 0 deletions docs/safety/debug-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "Debug Mode"
icon: "circle-info"
description: "Understand why the AI said what it said."
---

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.

## How to use this feature?

<Steps>
<Step title="Filter sessions">
Filter sessions by the AI agent. This will display a list of all ongoing conversations where the AI is active.
<video
autoPlay
muted
loop
playsInline
className="w-full aspect-video rounded-lg"
src="/images/filter.mp4">
</video>
</Step>
<Step title="Click on the debug button">
Clicking this will open a popup showing the data the AI used to answer the question.
<video
autoPlay
muted
loop
playsInline
className="w-full aspect-video rounded-lg"
src="/images/debug-mode.mp4">
</video>
</Step>
<Step title="Actions, Knowledge, and Keywords">
- **Actions**: These represent the steps the AI took to formulate its response.
- **Knowledge**: This shows the data or knowledge the AI relied on to answer the question.
- **Keywords**: These are the search terms or keywords the AI used in its hybrid search process.
</Step>
</Steps>

## How to enable debug mode on the widget?
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)


Read more <a href="/widget/embed#available-options">here</a>
30 changes: 30 additions & 0 deletions docs/safety/inspect-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Inspect Mode"
icon: "eye"
description: "See what the AI is doing in real time and intervene if needed."
---

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.

## How to use this feature?

<Steps>
<Step title="Filter sessions">
Filter sessions by the AI agent. This will provide a list of all ongoing conversations where the AI is active.
<video
autoPlay
muted
loop
playsInline
className="w-full aspect-video rounded-lg"
src="/images/filter.mp4">
</video>
</Step>
<Step title="Select a session">
Click on the session you want to inspect. This will open Inspect Mode.
<img src="/images/inspect-mode-message.png" alt="Inspect Mode" className="w-full rounded-lg"/>
</Step>
<Step title="Take over if needed">
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.
</Step>
</Steps>
68 changes: 68 additions & 0 deletions docs/safety/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: "Introduction"
icon: "shield-check"
description: "We have gone further than anyone in on the market to make sure that our AI is safe and reliable."
---
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.

## Observability & Interpretability

These features are designed to give human agents the ability to see and understand the AI while it’s at work.

<CardGroup cols={2}>
<Card
title="Inspect Mode"
icon="hand-holding-heart"
color="#f7b245"
iconType="solid"
href="/safety/inspect-mode"
>
</Card>

<Card
title="Debug Mode"
icon="gear"
color="#f7b245"
iconType="solid"
href="/safety/debug-mode"
>
</Card>

<Card
title="Human Takeover"
icon="inbox"
color="#f7b245"
iconType="solid"
href="/safety/inspect-mode"
>
</Card>

<Card
title="Handoff"
icon="inbox"
color="#f7b245"
iconType="solid"
href="/resources/human-handoff"
>
</Card>
</CardGroup>


## Assist Mode (formerly Draft Mode)

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.

<CardGroup cols={2}>
<Card
title="Assist Mode"
icon="hand-holding-heart"
color="#f7b245"
iconType="solid"
href="/resources/assist-mode"
>
</Card>
</CardGroup>

## Compliance

We are in the process of achieving SOC-2 certification, which is expected to be completed by Q4 2024.

0 comments on commit 852ac49

Please sign in to comment.