-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: rebrand to obot #958
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
@@ -1,42 +1,60 @@ | ||
# Agents | ||
|
||
An agent is a program that combines AI, a set of instructions, and access to your services and data to perform tasks, answer questions, and interact with its environment. Administrators create agents for end-users to interact with. Below are the key concepts and fields you need to understand to build an agent. | ||
An agent is a program that combines AI, a set of instructions, and access to your services and data to perform tasks, answer questions, and interact with its environment. | ||
Administrators create agents for end-users to interact with. Below are the key concepts and fields you need to understand to build an agent. | ||
|
||
### Name and Description | ||
These fields will be shown to your end-users to help them identify and understand your agents. | ||
|
||
### Instructions | ||
Instructions let you guide your agent's behavior. You should use this field to specify things like the agent's objectives, goals, personality, and anything special it should know about its users or use cases. Here is an example set of instructions for a HR Assistant designed to answer employee's HR-related questions and requests: | ||
Instructions let you guide your agent's behavior. | ||
You should use this field to specify things like the agent's objectives, goals, personality, and anything special it should know about its users or use cases. | ||
Here is an example set of instructions for a HR Assistant designed to answer employee's HR-related questions and requests: | ||
|
||
> You are an HR assistant for Acme Corporation. Employees of Acme Corporation will chat with you to get answers to HR related questions. If an employee seems unsatisfied with your answers, you can direct them to email [email protected]. | ||
|
||
### Model | ||
You can specify the model each agent will use. If you make no selection, the system default will be used. For more on models, see our [Models concept](models). | ||
|
||
### Tools | ||
Tools dictate what an agent can do and how it can interact with the rest of the world. The tools shipped with Otto8 help make their purpose clear. A few examples include: | ||
Tools dictate what an agent can do and how it can interact with the rest of the world. The tools shipped with Obot help make their purpose clear. A few examples include: | ||
- Creating an email draft | ||
- Sending a Slack message | ||
- Getting the contents of a web page | ||
|
||
You can configure an agent with **Agent Tools** and **User Tools**, described below: | ||
- **Agent Tools** will always be enabled on an agent. The agent will always be able to call them. | ||
- **User Tools** are optional. They are available for a user to add to their chat with the agent. Users can add and remove these tools at will. | ||
- **User Tools** are optional. They are available for a user to add to their chat with the agent. Users can add and remove these tools at will. | ||
|
||
### Knowledge | ||
Knowledge lets you supply your agent with information unique to its use case. You can upload files directly or pull in data from Notion, OneDrive, or a website. If you've configured your agent with knowledge, it will make queries to its knowledge database to help respond to the users' requests. | ||
Knowledge lets you supply your agent with information unique to its use case. | ||
You can upload files directly or pull in data from Notion, OneDrive, or a website. | ||
If you've configured your agent with knowledge, it will make queries to its knowledge database to help respond to the users' requests. | ||
|
||
You should supply a useful **Knowledge Description** to help the agent determine when it should make a query. Here is an example knowledge description for an HR Assistant that has documents regarding a companies HR policies and procedures: | ||
You should supply a useful **Knowledge Description** to help the agent determine when it should make a query. | ||
Here is an example knowledge description for an HR Assistant that has documents regarding a companies HR policies and procedures: | ||
|
||
> Detailed documentation about the human resource policies and procedures for Acme Corporation. | ||
|
||
### Preview Chat and Threads | ||
When creating an agent, you can chat with it to see how it behaves based on how you've configured it. You can even create access past preview threads to compare behavior as your iterate on it. | ||
When creating an agent, you can chat with it to see how it behaves based on how you've configured it. | ||
You can even create access past preview threads to compare behavior as your iterate on it. | ||
|
||
|
||
### Publishing | ||
When you publish an agent, you make it available for end-users to chat with. You'll first be asked to specify an alias for the agent. This alias will be used to generate a unique URL for the agent. Only alphanumeric characters and hyphens are allowed. Once you've picked an alias and hit the publish button, the agent will immediately be available for users to discover and chat with. | ||
|
||
The end-user chat interface is available at the root of the domain on which otto8 is running. For example, if you accessed the admin UI at `https://otto8.acmecorp.com/admin`, the end-user chat UI is available at `https://otto8.acmecorp.com/`. A publish agent will be available in the agent dropdown on this page as well as at its own dedicated page based on its alias. For example, if you gave your agent the alias `hr-assistant`, it would be available at https://otto8.acmecorp.com/hr-assistant`. | ||
|
||
It is possible to request the same alias for two agents. This is to allow you to seamlessly swap agents out without your users noticing. For example, suppose you've published your first agent with the alias `hr-assistant` and it's available at `https://otto8.acmecorp.com/hr-assistant`. If you want to experiment with a new version of your agent, you can create a brand new one, refine its behavior, and when you're ready, set its alias to `hr-assistant` as well. When you're ready to switch your users to the new agent, just unpublish your first agent. Users will be swapped over to the new agent without losing any of their chat history. | ||
When you publish an agent, you make it available for end-users to chat with. | ||
You'll first be asked to specify an alias for the agent. This alias will be used to generate a unique URL for the agent. | ||
Only alphanumeric characters and hyphens are allowed. | ||
Once you've picked an alias and hit the publish button, the agent will immediately be available for users to discover and chat with. | ||
|
||
The end-user chat interface is available at the root of the domain on which Obot is running. | ||
For example, if you accessed the admin UI at `https://obot.acmecorp.com/admin`, the end-user chat UI is available at `https://obot.acmecorp.com/`. | ||
A published agent will be available in the agent dropdown on this page as well as at its own dedicated page based on its alias. | ||
For example, if you gave your agent the alias `hr-assistant`, it would be available at https://obot.acmecorp.com/hr-assistant`. | ||
|
||
It is possible to request the same alias for two agents. | ||
This is to allow you to seamlessly swap agents out without your users noticing. | ||
For example, suppose you've published your first agent with the alias `hr-assistant` and it's available at `https://obot.acmecorp.com/hr-assistant`. | ||
If you want to experiment with a new version of your agent, you can create a brand new one, refine its behavior, and when you're ready, set its alias to `hr-assistant` as well. | ||
When you're ready to switch your users to the new agent, just unpublish your first agent. | ||
Users will be swapped over to the new agent without losing any of their chat history. |
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 |
---|---|---|
@@ -1,5 +1,8 @@ | ||
# Threads | ||
|
||
A thread represents each chat conversation between an agent and a user or the execution of a workflow. On the Threads page, you'll find a list of all threads within your system. Clicking on a thread will display all related messages and metadata, such as files created or uploaded by the user. | ||
A thread represents each chat conversation between an agent and a user or the execution of a workflow. | ||
On the Threads page, you'll find a list of all threads within your system. | ||
Clicking on a thread will display all related messages and metadata, such as files created or uploaded by the user. | ||
|
||
Deleting a thread will permanently remove it from the system. If a deleted thread was associated with an agent, the user's chat history with that agent will be lost, and any new conversation will start afresh. | ||
Deleting a thread will permanently remove it from the system. | ||
If a deleted thread was associated with an agent, the user's chat history with that agent will be lost, and any new conversation will start afresh. |
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 |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# Tools | ||
|
||
Tools define an agent's capabilities and determine how it interacts with the world. Otto8 includes a wide range of built-in tools. To help illustrate what tools can do, here are a few examples: | ||
Tools define an agent's capabilities and determine how it interacts with the world. Obot includes a wide range of built-in tools. To help illustrate what tools can do, here are a few examples: | ||
- Creating email drafts | ||
- Sending Slack messages | ||
- Retrieving the contents of a web page | ||
|
||
The **Tools** page displays all built-in tools available in Otto8, along with any custom tools you've added. The built-in tools are open source and can be accessed [here](https://github.com/otto8-ai/tools). | ||
The **Tools** page displays all built-in tools available in Obot, along with any custom tools you've added. The built-in tools are open source and can be accessed [here](https://github.com/obot-platform/tools). | ||
|
||
For instructions on creating your own tools, refer to our [Tool Authoring Guide](/tools/first-tool). |
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 |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# Users | ||
|
||
The **Users** page displays all the users in your system. Users can be configured as admins by following our [configuration guide](/configuration/general). Non-admin users, referred to as "end-users" in this documentation, only have access to the chat interface available at the root of the domain where Otto8 is running. For example, if the admin interface is accessed at `https://otto8.acmecorp.com/admin`, the end-user chat interface would be available at `https://otto8.acmecorp.com/`. | ||
The **Users** page displays all the users in your system. Users can be configured as admins by following our [configuration guide](/configuration/general). | ||
Non-admin users, referred to as "end-users" in this documentation, only have access to the chat interface available at the root of the domain where Obot is running. | ||
For example, if the admin interface is accessed at `https://obot.acmecorp.com/admin`, the end-user chat interface would be available at `https://obot.acmecorp.com/`. |
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
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like we haven't update the homebrew formula..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, but I think we are going to after we release. Please correct me if I am wrong - @cjellick