Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions quill/channels/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ A channel's type is selected in the **Add channel** menu, described in [Adding a

<Panel heading="Channels and agents">

A channel is added for one of the app's [agents](../dashboard/manage-an-app/app-agents-view.mdx), and carries
A channel is added for one of the app's [agents](../dashboard/manage-an-app/agents-view.mdx), and carries
conversations to this agent alone.
The following holds for channels of every type:

Expand Down Expand Up @@ -97,7 +97,7 @@ Channels of every type are added and managed in the same places of Quill's manag

<Panel heading="Binding agent parameters">

Some agents have [parameters](../dashboard/manage-an-app/app-agents-view.mdx#agent-parameters): values the agent's
Some agents have [parameters](../dashboard/manage-an-app/agents-view.mdx#agent-parameters): values the agent's
queries require, and that must come from the channel rather than be chosen by the LLM, like the phone number of the
customer whose orders the agent looks up.
Agent parameters are bound by the channel, and the source of a parameter's value depends on the channel type:
Expand Down
2 changes: 1 addition & 1 deletion quill/dashboard/ai-connection-strings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import ContentFrame from '@site/src/components/ContentFrame';

* Agents refer to connection strings by name.
Select a connection string when you [create](../getting-started/adding-an-ai-agent.mdx#connecting-to-your-llm-provider)
or [edit](manage-an-app/app-agents-view.mdx#the-agent-s-configuration) an agent.
or [edit](manage-an-app/agents-view.mdx#the-agent-s-configuration) an agent.

* In this article:
* [The AI connection strings view](#the-ai-connection-strings-view)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "App: Agents view"
sidebar_label: Agents view
title: "App: Agents View"
sidebar_label: Agents View
sidebar_position: 3
description: "The Agents view of a Quill app: the agents that answer your users, listed with their status and activity, and an agent's configuration, where its basic settings, parameters, query tools, and actions are modified, and the agent is tested, saved, or deleted."
---
Expand All @@ -11,15 +11,14 @@ import TabItem from '@theme/TabItem';
import Panel from "@site/src/components/Panel";
import ContentFrame from "@site/src/components/ContentFrame";

# App: Agents view
<Admonition type="note" title="">

* An [AI agent](../../overview.mdx#ai-agent) answers your users from the app's internal database.
The **Agents** view lists the agents you already created, with their status and activity, and allows you to add new
agents, open an agent to modify and test its configuration, and delete an agent.

* The Agents view is opened from the app's sidebar, where it is listed under the **Database** group.
The app's [Overview](../../dashboard/manage-an-app/app-overview.mdx) page also lists the existing agents,
The app's [Overview](../../dashboard/manage-an-app/overview.mdx) page also lists the existing agents,
to provide an overall view of the app's activity, agents, and channels.

* An agent is added using the **Add agent** wizard, described in
Expand All @@ -41,7 +40,7 @@ import ContentFrame from "@site/src/components/ContentFrame";

To open the Agents view, select the app in Quill's management dashboard and click **Agents** in the sidebar, under **Database**.

![The Agents view](./assets/app-agents-view_agents-view.png)
![The Agents view](./assets/agents-view_agents-view.png)

1. **Agents**
Open the Agents view.
Expand Down Expand Up @@ -80,7 +79,7 @@ To open the Agents view, select the app in Quill's management dashboard and clic
An agent's behaviour is set by its configuration.
To review and modify an agent's configuration, click the agent's pencil icon in the agents list.

![The agent's configuration](./assets/app-agents-view_agent-view.png)
![The agent's configuration](./assets/agents-view_agent-view.png)

You can expand or collapse each configuration section: [Basic settings](#basic-settings),
[Agent parameters](#agent-parameters), [Agent tools](#agent-tools), and [Agent actions](#agent-actions).
Expand All @@ -96,7 +95,7 @@ You can expand or collapse each configuration section: [Basic settings](#basic-s

### Basic settings

![Basic settings](./assets/app-agents-view_agent-view_basic-settings.png)
![Basic settings](./assets/agents-view_agent-view_basic-settings.png)

* **A. Agent name**
The **Agent name** field is disabled; it cannot be modified since the agent's identifier is derived from its name
Expand All @@ -121,11 +120,11 @@ You can expand or collapse each configuration section: [Basic settings](#basic-s
Expanding the **Agent parameters** section shows the parameters defined for the agent.
The image below lists a single parameter, `customerPhone`.

![Agent parameters](./assets/app-agents-view_agent-parameters.png)
![Agent parameters](./assets/agents-view_agent-parameters.png)

Adding or editing a parameter reveals the following fields:

![Configure parameter](./assets/app-agents-view_agent-parameters_configure.png)
![Configure parameter](./assets/agents-view_agent-parameters_configure.png)

* **A. Parameter name**
The name by which agent queries refer to the parameter.
Expand Down Expand Up @@ -164,11 +163,11 @@ You can expand or collapse each configuration section: [Basic settings](#basic-s
Expanding the **Agent tools** section shows the query tools defined for the agent.
The image below lists two such tools, `getCustomerByPhone` and `findCategoryProducts`.

![Agent tools](./assets/app-agents-view_agent-tools.png)
![Agent tools](./assets/agents-view_agent-tools.png)

Adding or editing a query tool reveals the following fields:

![Configure query tool](./assets/app-agents-view_agent-tools_configure.png)
![Configure query tool](./assets/agents-view_agent-tools_configure.png)

* **A. Tool name**
The name the LLM uses to trigger the query.
Expand Down Expand Up @@ -261,11 +260,11 @@ You can expand or collapse each configuration section: [Basic settings](#basic-s
Expanding the **Agent actions** section shows the actions defined for the agent.
The image below lists a single action, `create_ticket`.

![Agent actions](./assets/app-agents-view_agent-actions.png)
![Agent actions](./assets/agents-view_agent-actions.png)

Adding or editing an action reveals the following fields:

![Configure action](./assets/app-agents-view_agent-actions_configure.png)
![Configure action](./assets/agents-view_agent-actions_configure.png)

* **A. Action name**
The name the LLM uses to trigger this action.
Expand Down Expand Up @@ -337,18 +336,18 @@ agent's menu described in [The agent's configuration](#the-agent-s-configuration
An agent cannot be deleted as long as any channel is bound to it; delete the agent's channels from the
[Channels view](../../dashboard/manage-an-app/channels-view.mdx) first, and only then the agent.

![Deleting an agent that channels are bound to](./assets/app-agents-view_delete-refused.png)
![Deleting an agent that channels are bound to](./assets/agents-view_delete-refused.png)

The conversations the agent has held are kept, and remain available in the app's [Conversations view](../../dashboard/manage-an-app/conversations-view.mdx).

</Panel>

<Panel heading="An additional entry point: the agents list in the Overview">

Similarly to the Agents view discussed here, the app's [Overview](../../dashboard/manage-an-app/app-overview.mdx) page
Similarly to the Agents view discussed here, the app's [Overview](../../dashboard/manage-an-app/overview.mdx) page
lists your existing agents and allows you to add an agent or edit an existing agent's configuration.

![The agents list in the Overview](./assets/app-agents-view_overview-agents.png)
![The agents list in the Overview](./assets/agents-view_overview-agents.png)

1. **Add agent**
Start the [Add agent wizard](../../getting-started/adding-an-ai-agent.mdx) to add an agent to the app.
Expand Down
7 changes: 3 additions & 4 deletions quill/dashboard/manage-an-app/channels-view.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "App: Channels view"
sidebar_label: Channels view
title: "App: Channels View"
sidebar_label: Channels View
sidebar_position: 5
description: "The Channels view of a Quill app: the channels the app serves its users through, listed by type, with the actions common to every channel type: adding a channel, opening its details view, editing, pausing and resuming, and deleting it."
---
Expand All @@ -9,7 +9,6 @@ import Admonition from '@theme/Admonition';
import Panel from "@site/src/components/Panel";
import ContentFrame from "@site/src/components/ContentFrame";

# App: Channels view
<Admonition type="note" title="">

* A [channel](../../overview.mdx#channels) carries the conversations between your users and one of your app's agents: a chat widget
Expand Down Expand Up @@ -73,7 +72,7 @@ To open it, open the app in Quill's management dashboard and click **Channels**

<Panel heading="Adding a channel">

A channel is added for one of the app's [agents](../../dashboard/manage-an-app/app-agents-view.mdx), and carries
A channel is added for one of the app's [agents](../../dashboard/manage-an-app/agents-view.mdx), and carries
conversations to this agent alone.
Adding a new channel starts with selecting the channel's type: click **New channel** in the Channels view (or **Add channel**
in the [Overview's channels list](#an-additional-entry-point-the-channels-list-in-the-overview)) to open the menu of types, and
Expand Down
9 changes: 4 additions & 5 deletions quill/dashboard/manage-an-app/conversations-view.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "App: Conversations view"
sidebar_label: Conversations view
title: "App: Conversations View"
sidebar_label: Conversations View
sidebar_position: 4
description: "The Conversations view of a Quill app: the conversations the app's agents held with your users, listed with their parameters, last exchange, and activity time, and each conversation's full transcript, including the tools the agent ran."
---
Expand All @@ -9,7 +9,6 @@ import Admonition from '@theme/Admonition';
import Panel from "@site/src/components/Panel";
import ContentFrame from "@site/src/components/ContentFrame";

# App: Conversations view
<Admonition type="note" title="">

* A **conversation** is the exchange between one of your users and an
Expand Down Expand Up @@ -86,7 +85,7 @@ sidebar, under **Database**.
* **Agent**
The identifier of the agent that held the conversation, derived from the agent's name.
Open the agent's configuration from the
[Agents view](../../dashboard/manage-an-app/app-agents-view.mdx#the-agent-s-configuration).
[Agents view](../../dashboard/manage-an-app/agents-view.mdx#the-agent-s-configuration).
* **Channel**
The channel that carried the conversation.
The cell is empty when the conversation was held in the agent's test chat, or when the channel that carried the
Expand Down Expand Up @@ -122,7 +121,7 @@ The transcript sheet holds the conversation as it ran, including the user prompt
The agent that held the conversation, and the channel that carried it.
2. **Parameters**
Expanding the **Parameters** section shows any
[agent parameters](../../dashboard/manage-an-app/app-agents-view.mdx#agent-parameters) bound for the conversation,
[agent parameters](../../dashboard/manage-an-app/agents-view.mdx#agent-parameters) bound for the conversation,
each with the value it was given.
![The conversation's parameters](./assets/conversations-view_parameters.png)
3. **System prompt**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import ContentFrame from "@site/src/components/ContentFrame";

<Panel heading="The data source view">

![Data source](./assets/app-data-source-1.png)
![Data source](./assets/data-source-view-1.png)

1. **Data source**
To open the selected app's **Data source** page, click **Data source** under **Database** in the sidebar.
Expand Down Expand Up @@ -60,7 +60,7 @@ import ContentFrame from "@site/src/components/ContentFrame";
An additional **Restart sync** button appears beside the menu when the page reports sync errors.
See [Data source actions](#data-source-actions) for instructions and the effects of each action.

![Data source](./assets/app-data-source-2.png)
![Data source](./assets/data-source-view-2.png)

5. **Sync performance**
Shows the sync's current activity, the **Recent writes** and **Errors** counters, and a live batch log.
Expand All @@ -78,7 +78,7 @@ This section updates automatically as sync reports arrive.
While establishing the live connection, it displays "_Connecting to the live data sync..._".
If the connection fails or closes, Quill displays "_Could not connect to the live data sync_" with a **Retry** button.

![Data source - Sync performance](./assets/app-data-source-3.png)
![Data source - Sync performance](./assets/data-source-view-3.png)

<ContentFrame>

Expand Down Expand Up @@ -106,7 +106,7 @@ If the connection fails or closes, Quill displays "_Could not connect to the liv
It includes recent batches available when you open the page, plus batches received while the page remains open.

Reloading the page can change the total because older batches may no longer be available.
For the app's database write usage over a selected period, see the **WRU** tile on the [Overview](./app-overview.mdx#activity) page.
For the app's database write usage over a selected period, see the **WRU** tile on the [Overview](./overview.mdx#activity) page.

3. **Errors**
Quill shows the higher of these two counts:
Expand Down Expand Up @@ -173,7 +173,7 @@ If the connection fails or closes, Quill displays "_Could not connect to the liv

### Sync errors

![Data source - Sync errors](./assets/app-data-source-4.png)
![Data source - Sync errors](./assets/data-source-view-4.png)

* A **Sync errors detected** banner appears at the top of **Sync performance** when the sync error list
contains entries. The banner shows the number of errors returned in that list, up to 25.
Expand All @@ -197,7 +197,7 @@ If the connection fails or closes, Quill displays "_Could not connect to the liv

<Panel heading="Collections">

![Data source - Collections](./assets/app-data-source-5.png)
![Data source - Collections](./assets/data-source-view-5.png)

The **Collections** table lists the collections in the app's RavenDB database, in alphabetical order.
The badge beside the heading shows how many collections there are.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import ContentFrame from "@site/src/components/ContentFrame";

<Panel heading="The app overview">

![App overview](./assets/app-overview-1.png)
![App overview](./assets/overview-1.png)

1. **App selector**
The header shows the current app. Click the app's name to switch to another app.
Expand Down Expand Up @@ -64,7 +64,7 @@ import ContentFrame from "@site/src/components/ContentFrame";

The **Activity** section reports conversations, prompts, tokens, and write usage for this app during the selected period.

![App overview - Activity](./assets/app-overview-2.png)
![App overview - Activity](./assets/overview-2.png)

<ContentFrame>

Expand Down Expand Up @@ -131,12 +131,12 @@ A chart is not shown when the selected period contains only one bucket.

<Panel heading="Agents">

![App overview - Agents](./assets/app-overview-3.png)
![App overview - Agents](./assets/overview-3.png)

The table lists every agent configured in the app.
If the app has no agents, the table displays **No agents yet.**
The agents themselves are added, modified and deleted in the
[App: Agents view](../../dashboard/manage-an-app/app-agents-view.mdx).
[App: Agents view](../../dashboard/manage-an-app/agents-view.mdx).

1. **Agent name**
The name assigned to the agent when it was created.
Expand Down Expand Up @@ -197,7 +197,7 @@ The agents themselves are added, modified and deleted in the

<Panel heading="Channels">

![App overview - Channels](./assets/app-overview-4.png)
![App overview - Channels](./assets/overview-4.png)

The table lists every channel configured in the app, with the newest channel first.
If the app has no channels, the table displays **No channels yet.**
Expand Down Expand Up @@ -256,7 +256,7 @@ If the app has no channels, the table displays **No channels yet.**

<Panel heading="Sync errors">

![App overview - Channels](./assets/app-overview-5.png)
![App overview - Channels](./assets/overview-5.png)

* A **Sync errors detected** banner appears at the top of the page when Quill reports errors while [mirroring](../../overview.mdx#mirroring) changes from the source database.

Expand Down
10 changes: 5 additions & 5 deletions quill/dashboard/my-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import ContentFrame from "@site/src/components/ContentFrame";

5. **Add app**
Click **Add app** to open the [wizard](../getting-started/connecting-your-database.mdx#starting-the-add-new-app-wizard)
for connecting a source database and creating a new app.
to connect a source database and create a new app.

</Panel>

Expand Down Expand Up @@ -134,7 +134,7 @@ Until the first app is added, the table is replaced by **No apps added yet** and

3. **Agents**
The number of agents configured in the app.
See [App: Agents view](../dashboard/manage-an-app/app-agents-view.mdx).
See [App: Agents view](../dashboard/manage-an-app/agents-view.mdx).

4. **Channels**
The channel types configured for the app, such as **Web widget**.
Expand All @@ -161,9 +161,9 @@ Until the first app is added, the table is replaced by **No apps added yet** and
which takes precedence over **All channels disabled**. Having no channels does not by itself produce a warning.

7. **Add app**
Click **Add app** to open the wizard for [connecting a source database](../getting-started/connecting-your-database.mdx#starting-the-add-new-app-wizard),
[mapping the tables](../getting-started/mapping-your-tables.mdx) Quill will mirror,
and creating a new app.
Click **Add app** to open the wizard to [connect a source database](../getting-started/connecting-your-database.mdx#starting-the-add-new-app-wizard),
[map the tables](../getting-started/mapping-your-tables.mdx) Quill will mirror,
and create a new app.

8. **Edit**
Click the pencil and confirm to reopen the wizard with the app's existing configuration.
Expand Down
2 changes: 1 addition & 1 deletion quill/getting-started/adding-an-ai-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ to **Add a channel**, the last stage.
![Agent created](./assets/adding-an-ai-agent_agent-created.png)

The created agent is listed in the app's **Agents** table, where its configuration can be reviewed and modified at any
time. See [App: Agents view](../dashboard/manage-an-app/app-agents-view.mdx).
time. See [App: Agents view](../dashboard/manage-an-app/agents-view.mdx).

![Agent listed](./assets/adding-an-ai-agent_agent-listed.png)

Expand Down
2 changes: 1 addition & 1 deletion quill/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ The dashboard opens with the deployment's apps; each app then has an overview of

1. The welcome banner tracks the app's three setup steps: a connected data source, a first agent, and a channel.
2. The Activity tiles follow the app's conversations, messages, and usage over the selected period.
3. The [Agents table](dashboard/manage-an-app/app-agents-view.mdx) lists the app's agents, each with its status, model, and activity.
3. The [Agents table](dashboard/manage-an-app/agents-view.mdx) lists the app's agents, each with its status, model, and activity.
4. The Channels table lists the app's channels, each with its type, status, and active embed links.

The sidebar leads to the app's sections: the data source, the agents, the conversations, and settings like channels
Expand Down
Loading