AgentOps Docs (#412)

Agentops documentation
crewAIInc · Apr 4, 2024 · fcffc4a · fcffc4a
1 parent 8ed4c66
commit fcffc4a
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 1 deletion.
diff --git a/docs/assets/agentops-overview.png b/docs/assets/agentops-overview.png
diff --git a/docs/assets/agentops-replay.png b/docs/assets/agentops-replay.png
diff --git a/docs/assets/agentops-session.png b/docs/assets/agentops-session.png
diff --git a/docs/how-to/AgentOps-Observability.md b/docs/how-to/AgentOps-Observability.md
@@ -0,0 +1,72 @@
+---
+title: (AgentOps) Observability using AgentOps
+description: Understanding and logging your agent performance with AgentOps.
+---
+
+# Intro
+Observability is a key aspect of developing and deploying conversational AI agents. It allows developers to understand how the agent is performing, how users are interacting with the agent, and how the agent is responding to user inputs. 
+
+AgentOps is a product, idependent of crewAI that provides a comprehensive observability solution for agents. 
+
+This notebook will provide an overview of AgentOps and how to use it with crewAI.
+
+## AgentOps
+
+[AgentOps](https://agentops.ai) provides session replays, metrics, and monitoring for agents.
+[AgentOps Repo](https://github.com/AgentOps-AI/agentops)
+
+### Overview
+AgentOps provides monotoring for agents in development and production. It provides a dashboard for monitoring agent performance, session replays, and custom reporting.
+
+![agentops-overview.png](..%2Fassets%2Fagentops-overview.png)
+
+Additionally, AgentOps provides session drilldowns that allows users to view the agent's interactions with users in real-time. This feature is useful for debugging and understanding how the agent interacts with users.
+
+![agentops-session.png](..%2Fassets%2Fagentops-session.png)
+![agentops-replay.png](..%2Fassets%2Fagentops-replay.png)
+
+### Features
+- LLM Cost management and tracking
+- Replay Analytics
+- Recursive thought detection
+- Custom Reporting
+- Analytics Dashboard
+- Public Model Testing
+- Custom Tests
+- Time Travel Debugging
+- Compliance and Security
+
+### Using AgentOps
+
+Create a user API key here: app.agentops.ai/account
+
+Add your API key to your environment variables
+
+```
+AGENTOPS_API_KEY=<YOUR_AGENTOPS_API_KEY>
+```
+
+Install AgentOps with:
+```
+pip install crewai[agentops]
+```
+or
+```
+pip install agentops
+```
+
+Before using `Crew` in your script, include these lines:
+
+```python
+import agentops
+agentops.init()
+```
+
+### Crew + AgentOps Examples
+- [Job Posting](https://github.com/joaomdmoura/crewAI-examples/tree/main/job-posting)
+- [Markdown Validator](https://github.com/joaomdmoura/crewAI-examples/tree/main/markdown_validator)
+- [Instagram Post](https://github.com/joaomdmoura/crewAI-examples/tree/main/instagram_post)
+
+
+### Futher Information
+To implement more features and better observability, please see the [AgentOps Repo](https://github.com/AgentOps-AI/agentops)
diff --git a/docs/index.md b/docs/index.md
@@ -73,6 +73,11 @@ Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By
                     Human Input on Execution
                 </a>
             </li>
+            <li>
+                <a href="./how-to/AgentOps-Observability.md">
+                    Agent Observability using AgentOps
+                </a>
+            </li>
         </ul>
     </div>
     <div style="width:30%">
@@ -115,4 +120,4 @@ Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By
             </li>
         </ul>
     </div>
-</div>
+</div>