-
Notifications
You must be signed in to change notification settings - Fork 246
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs overhaul - Introduction+Quickstart (#221)
* Consolidating * WIP * typo * Fixing Cohere * Added Introduction * WIP * Consolidating * WIP * typo * Fixing Cohere * Added Introduction * WIP * Adding syntax highlighting * Added to env var * Wrapping up * Done
- Loading branch information
Showing
17 changed files
with
150 additions
and
102 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,19 +1,24 @@ | ||
--- | ||
title: "Environment Variables" | ||
description: "Environment Variables that AgentOps will look for" | ||
mode: "wide" | ||
--- | ||
|
||
### Sample .env file | ||
|
||
```.env | ||
```python .env | ||
# API KEY for using AgentOps. Find this in your settings page | ||
AGENTOPS_API_KEY=<YOUR API KEY> | ||
# Secondary API Key for simultaneously recording to a second project | ||
|
||
########################################################## | ||
# Only copy the following if you're going to override them | ||
|
||
# (OPTIONAL) Secondary API Key for simultaneously recording to a second project | ||
AGENTOPS_PARENT_KEY=<YOUR PARENT KEY> | ||
# The AgentOps API endpoint. Defaults to https://api.agentops.ai | ||
# (OPTIONAL) The AgentOps API endpoint. Defaults to https://api.agentops.ai | ||
AGENTOPS_API_ENDPOINT=https://api.agentops.ai | ||
# Logging level. <DEBUG, INFO, CRITICAL> | ||
# (OPTIONAL) Logging level. <DEBUG, INFO, CRITICAL> | ||
AGENTOPS_LOGGING_LEVEL=INFO | ||
# Whether to opt out of recording environment data. <FALSE, TRUE> | ||
# (OPTIONAL) Whether to opt out of recording environment data. <FALSE, TRUE> | ||
AGENTOPS_ENV_DATA_OPT_OUT=FALSE | ||
``` |
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
This file was deleted.
Oops, something went wrong.
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,23 +1,60 @@ | ||
--- | ||
title: Introduction | ||
description: "Build your next agent with evals, observability, and replay." | ||
title: "Introduction" | ||
description: "Build your next agent with evals, observability, and replays" | ||
mode: "wide" | ||
--- | ||
|
||
## Get Started | ||
<Check>[Give us a star](https://github.com/AgentOps-AI/agentops) on GitHub if you find AgentOps helpful (you may be our 1,000th 😊)</Check> | ||
|
||
<CardGroup cols={2}> | ||
<Card title="Installing AgentOps" icon="wrench" href="./installation"> | ||
Prepare your system for AgentOps | ||
</Card> | ||
<Card title="Quick Start" icon="rocket" href="./quickstart"> | ||
Start using AgentOps with just 3 lines of code | ||
</Card> | ||
</CardGroup> | ||
# AgentOps is your new terminal | ||
|
||
## Integrate with your agent | ||
<Card title="Terminals suck" icon="trash" iconType="solid" color="#CC0000"> | ||
- • Lose track of what your agents did in between executions | ||
- • Parsing through terminal output searching for LLM completions | ||
- • Printing "tool called" | ||
</Card> | ||
<Card title="AgentOps doesn't" icon="face-smile-halo" iconType="duotone" color="#00CC00"> | ||
- • Visual dashboard so you can see what your agents did in human-readable format | ||
- • LLM calls are magically recorded - prompt, completion, timestamps for each - with one line of code | ||
- • Agents and their events (including tool calls) are recorded with one more line of code | ||
- • Errors are magically associated to its causal event | ||
- • Record any other events to your session with two more lines of code | ||
- • Tons of other useful data if you're developing with supported agent frameworks: SDK version | ||
</Card> | ||
|
||
<CardGroup cols={2}> | ||
<Card title="Example Code" icon="square-code" href="./examples"> | ||
Sample code that you can run! | ||
</Card> | ||
</CardGroup> | ||
## The AgentOps Dashboard | ||
|
||
With just two lines of code, you can free yourself from the chains of the terminal and instead visualize your agents' behavior | ||
in your AgentOps Dashboard. After setting up AgentOps, each execution of your program is recorded as a session and the above | ||
data is automatically recorded for you. | ||
|
||
The examples below were captured with two lines of code. | ||
|
||
### Session Drilldown | ||
Here you will find a list of all of your previously recorded sessions and useful data about each such as total execution time. | ||
You also get helpful debugging info such as any SDK versions you were on if you're building on a supported agent framework like Crew or AutoGen. | ||
LLM calls are presented as a familiar chat history view, and charts give you a breakdown of the types of events that were called and how long they took. | ||
|
||
<Frame type="glass" caption="Session Summary"> | ||
<img height="200" src="/images/session-summary.gif" /> | ||
</Frame> | ||
|
||
Find any past sessions from your Session Drawer. | ||
<Frame type="glass" caption="Session Drawer"> | ||
<img height="250" src="/images/session-drawer.gif" /> | ||
</Frame> | ||
|
||
Most powerful of all is the Session Waterfall. On the left, a time visualization of all your LLM calls, Action events, Tool calls, and Errors. | ||
On the right, specific details about the event you've selected on the waterfall. For instance the exact prompt and completion for a given LLM call. | ||
Most of which has been automatically recorded for you. | ||
|
||
<Frame type="glass" caption="Session Waterfall"> | ||
<img height="200" src="/images/session-waterfall.gif" /> | ||
</Frame> | ||
|
||
|
||
### Session Overview | ||
View a meta-analysis of all of your sessions in a single view. | ||
<Frame type="glass" caption="Session Overview"> | ||
<img height="200" src="/images/overview.gif" /> | ||
</Frame> |
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