Skip to main content
Version: 2.20.0

Sessions

This page explains how you start a session with the agent. It also explains how you open, export, share, unshare, rename, pin, and delete a session.

Related pages:

What belongs in one session?​

Keep a session to one topic. Start a new session for a new question. A session that mixes many topics gives the agent a long, mixed history, and its replies lose focus.

See Keep one topic in one session.

Who can see a session?​

Every session you start is private. You are its owner. Only the owner can share, unshare, or delete a session.

When you share a session, every user of your installation can open it. Those users can also send messages into the session. They can stop the agent while it writes a reply. They can also rename, export, and pin the session.

Hyground can also start sessions on its own. A scheduled session and an Auto RCA are shared from the start. No user owns them, so no user can unshare or delete them. See Sessions Hyground starts.

Sharing also exposes what the agent brought in from your earlier sessions. See What does sharing disclose?.

Start a session​

  1. Click the Sessions icon in the left navigation. The Sessions page opens.

  2. Click New session at the top of the session panel.

    The New session button at the top of the session panel is marked.

  3. Type your message in the message box at the bottom. The empty box reads Ask Hyground... until you type.

  4. Press Enter.

Press Shift+Enter to start a new line without sending your message. Press Shift+Enter in a list item, such as 1. Check the logs, to start the next item. Press Shift+Enter on an empty item to end the list.

The Sessions page has a message box too. Type your message there and press Enter to start a session.

For a walk-through of a whole session, see Your first session. For what to write in your message, see Write a good message.

Open a session​

  1. Click the Sessions icon in the left navigation. The Sessions page opens.

  2. Click the title of the session in the table.

    The title of one session in the Sessions table is marked.

The session panel lists your most recent sessions and the recent sessions other users shared. It groups them under Today and Older. A Pinned group appears above them after you pin a session.

Each group header shows the number of sessions it lists. Click a group header to close that group. Click it again to open it.

Click All sessions below New session for the full list. The Older group shows at most 30 sessions. When it is full, the group ends with a Show all sessions link.

Click an entry in the session panel to open that session. A users icon marks a session that you or another user shared. An infinity icon marks a session that you marked Keep alive.

The bottom of the session panel tells you after how many days without activity Hyground deletes a session. See How long does Hyground keep a session?.

While the agent writes, you can stop the reply or queue a message.

What is in the session menu?​

Click the three dots icon in the top right corner of an open session. The session menu opens.

The top of the menu shows the session title and the last interaction. It also shows whether the session is Private or Shared.

An Owner badge names the user who started the session. The badge reads Unknown user when that user account no longer exists. The badge reads Hyground for a scheduled session and an Auto RCA.

The menu holds these entries:

If you do not own the session, Hyground shows Unshare in grey. You cannot click it. The menu does not show Delete.

On the Sessions page, a session you do not own shows no Shared switch. The delete icon stays clickable. See What does the Sessions page show?.

What does the Sessions page show?​

The Sessions page lists the sessions that users started. It shows your own sessions and every session another user shared. The Owner column names the user who started the session. The Shared column has a switch for each of your sessions. The switch is on when the session is shared. A session that another user shared with you shows the Shared with you badge instead.

The Keep Alive column has a switch for each session. The switch is on for a session that you marked Keep alive. Click the switch to turn Keep alive on or off. Point to the column header to read what Keep alive does.

The table lists your pinned sessions first. A pin icon marks each of them. The other sessions follow, the latest interaction first.

Use the search box in the top right corner of the page to find a session. Its placeholder reads Search title and content. Use the Date range field beside it to see only sessions from a period you choose. Turn on the My sessions switch to see only the sessions you started.

Search covers only the most recent sessions. These include the sessions other users shared. Search shows the best matches first, not the newest sessions first.

Hyground shows a hint above the table when the search could not cover every session. Add a Date range to reach older sessions.

The table shows 12 sessions on each page. Use the Page size dropdown below the table to show 24 or 60.

Scheduled sessions and Auto RCAs are not in this table. Each kind has its own page. See Where do you find them?.

The Actions column shows the pin icon, the download icon and the delete icon in every row. See Export a session.

The delete icon shows also in rows for sessions you do not own. Hyground still opens the Delete Session dialog. The delete then fails after you confirm, and the notification names the reason.

Export a session​

  1. Open the Sessions page.

  2. Find the session in the table.

  3. Click the download icon in the Actions column. Its tooltip reads Export session.

    The download icon of one session in the Sessions table is marked.

For the contents of the file, see What does an export contain?.

You can also click Export in the session menu to download the session.

What does an export contain?​

An export contains the whole session, including the agent's replies and the results of tool calls.

Every user message stays in the file. This includes the messages that other users sent into a shared session. The names of the tools the agent ran and the values it passed to them stay in the file.

If the session references files, the download is a ZIP archive that also holds those files. Otherwise the download is a single JSON file.

For what a session stores in the first place, see Your data.

Share a session​

  1. Open the Sessions page.

  2. Find your session in the table.

  3. Turn on the switch in the Shared column.

    The Shared switch of a private session in the Sessions table is marked.

  4. Click Yes in the Share Session dialog.

The switch is now on.

The Share Session dialog uses the words team members. This means every user of your installation, not a smaller group.

The dialog also shows the link to the session. Click the copy icon next to the link to copy it. Other users can open the link after you click Yes.

The dialog also warns you when the session holds recalled content from your private sessions. Other users can then read that content too. After you share a session, the agent recalls shared sessions only. See What can the agent recall in a shared session?.

You can also click Share in the session menu. The same dialog opens.

Unshare a session​

  1. Open the Sessions page.

  2. Find your shared session in the table.

  3. Turn off the switch in the Shared column.

    The Shared switch of a shared session in the Sessions table is marked.

  4. Click Yes in the Unshare Session dialog.

The switch is now off.

You can also click Unshare in the session menu. The same dialog opens.

Rename a session​

  1. Open the session.

  2. Click the three dots icon in the top right corner.

  3. Click Rename.

    The three dots icon and the open session menu show the Rename entry marked.

  4. Type the new title.

  5. Click Save.

Every user who can see the session sees the new title.

Pin a session​

  1. Open the session.

  2. Click the three dots icon in the top right corner.

  3. Click Pin.

    The three dots icon and the open session menu show the Pin entry marked.

The session moves into the Pinned group of the session panel. On the Sessions page, it moves to the top of the table. Other users do not see your pins. To remove the pin, click Pin again. The check mark disappears. On the Sessions page, you can also pin or unpin a session with the pin icon in the Actions column.

By default, Hyground deletes a session after 90 days without a new message. Hyground keeps the session if any user has pinned it or marked it Keep alive. See How long does Hyground keep a session?.

Keep a session alive​

Keep a session alive to protect it from automatic deletion without pinning it.

  1. Open the session.

  2. Click the three dots icon in the top right corner.

  3. Click Keep alive.

    The open session menu shows the Keep alive entry marked.

A check mark appears next to Keep alive. An infinity icon marks the session in the session panel. The session stays in its group. Other users do not see that you keep it alive.

Hyground does not delete the session automatically while any user has it marked Keep alive. To remove the mark, click Keep alive again. The check mark disappears.

You can also turn Keep alive on or off with the switch in the Keep Alive column of the Sessions page.

A pinned session is always kept alive. Its Keep alive entry is checked, and you cannot change it. On the Sessions page, a lock shows next to its switch. Unpin the session to change Keep alive.

Delete a session​

  1. Open the Sessions page.

  2. Find your session in the table.

  3. Click the delete icon in the Actions column. Its tooltip reads Delete session.

    The delete icon of one session in the Sessions table is marked.

  4. Click Yes in the Delete Session dialog.

Hyground deletes the session and its messages. You cannot undo this. If the session was shared, it disappears for every user.

You can also click Delete in the session menu. The same dialog opens.