Skip to content

Commit

Permalink
docs(assistants): add section to cloud docs, update nav, add docs pag…
Browse files Browse the repository at this point in the history
…es for what is, getting started, and runs (#1686)
  • Loading branch information
ian-griptape-ai authored Feb 11, 2025
1 parent 33a9f2e commit 4f6f8ce
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/griptape-cloud/assistants/assistant-runs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Assistant Runs

Assistant runs are individual executions of an [Assistant](./what-are-assistants.md).

Once you have created an Assistant, you can run it by sending messages. You can then view details for your runs, including sent and received messages and run configurations.
21 changes: 21 additions & 0 deletions docs/griptape-cloud/assistants/getting-started-with-assistants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Getting Started with Assistants

## How to create an Assistant

Follow these steps to create and use a simple chat Assistant.

1. Navigate to the Assistants page.
1. Click *Create Assistant*.
1. Give your Assistant a name and description (optional).
1. Select your [Knowledge Base](../knowledge-bases/what-are-knowledge-bases.md) from the *Knowledge Bases* dropdown menu.
1. Click *Create* to submit the form.

## How to use an Assistant

Once your Assistant has been created, you will be directed to the Assistant chat screen. Type a message to start a conversation thread with your new Assistant. Try asking it something about your data!

You can return to a previous conversation by selecting the corresponding thread in the *Run Config* panel to the right. Alternative, you can clear the conversation thread or start a new one.

> ### Pro Tip:
>
> Add a ruleset to provide your Assistant with instructions and guidance for how it should behave.
7 changes: 7 additions & 0 deletions docs/griptape-cloud/assistants/what-are-assistants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# What are Assistants?

AI applications don't always need to be complex to get the job done. Sometimes, all you need is a quick way to give an LLM secure access to your data. If you'd like to build a simple chat app that has access to your data sources, create an Assistant.

Assistants are a special type of Griptape chatbot Agent Structure that can be created easily in less than a minute, without writing or deploying any code. They offer much of the same functionality provided by Agent Structures, through a simple configurable interface.

Assistants can be configured to use Griptape Cloud resources such as [Knowledge Bases](../knowledge-bases/what-are-knowledge-bases.md), [Rulesets](../rules/rulesets.md), and [Tools](../tools/create-tool.md). Once your Assistant is created, you can immediately begin chatting with it by sending a message on the following screen.
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,13 @@ nav:
- Contributing: "contributing.md"
- Cloud:
- Overview: "griptape-cloud/index.md"
- Assistants:
- What are Assistants?: "griptape-cloud/assistants/what-are-assistants.md"
- Getting Started with Assistants: "griptape-cloud/assistants/getting-started-with-assistants.md"
- Assistant Runs: "griptape-cloud/assistants/assistant-runs.md"
- Data Sources:
- What are Data Sources?: "griptape-cloud/data-sources/what-are-data-sources.md"
- Getting Started With Data Sources: "griptape-cloud/data-sources/getting-started-with-data-sources.md"
- Getting Started with Data Sources: "griptape-cloud/data-sources/getting-started-with-data-sources.md"
- Create a Data Source: "griptape-cloud/data-sources/create-data-source.md"
- Refreshing Your Data: "griptape-cloud/data-sources/refresh-data.md"
- Data Lakes:
Expand Down

0 comments on commit 4f6f8ce

Please sign in to comment.