-
Notifications
You must be signed in to change notification settings - Fork 188
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(assistants): add section to cloud docs, update nav, add docs pag…
…es for what is, getting started, and runs (#1686)
- Loading branch information
1 parent
33a9f2e
commit 4f6f8ce
Showing
4 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
21
docs/griptape-cloud/assistants/getting-started-with-assistants.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters