diff --git a/README.md b/README.md index 37695301..6c89bd09 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,9 @@
- Session Debugging - Session Replays - Session Analytics - + Agent Debugging + Session Replays + Summary Analytics
All of this with just 2 lines of code
@@ -61,7 +60,7 @@ pip install agentops ``` -### Session replays in 2 lines of code +#### Session replays in 2 lines of code Initialize the AgentOps client and automatically get analytics on all your LLM calls. @@ -81,14 +80,11 @@ agentops.end_session('Success') All your sessions can be viewed on the [AgentOps dashboard](https://app.agentops.ai?ref=gh)
-For more functionality refer to our [documentation](http://docs.agentops.ai) - -
- Session Debugging + Agent Debugging - Session Analytics + Agent Debugging
@@ -100,34 +96,51 @@ For more functionality refer to our [documentation](http://docs.agentops.ai)
- Session Analytics + Summary Analytics - Agent Dashboard + Summary Analytics
-### More lines of code +### First class Developer Experience +Add powerful observability to your agents, tools and functions with as little code as possible: one line. +
+Refer to our [documentation](http://docs.agentops.ai) + ```python -import agentops +# Automatically associate all Events with the agent that originated them +from agentops import track_agent -# Beginning of program's code (i.e. main.py, __init__.py) -agentops.init(< INSERT YOUR API KEY HERE >) +@track_agent(name='SomeCustomName') +class MyAgent: + ... +``` -... +```python +# Automatically create ToolEvents for tools that agents will use +from agentops import record_tool +@record_tool('SampleToolName') +def sample_tool(...): + ... +``` + +```python +# Automatically create ActionEvents for other functions. +from agentops import record_action -# (optional: record specific functions) @agentops.record_action('sample function being record') def sample_function(...): - ... - - -# End of program -agentops.end_session('Success') + ... ``` +```python +# Manually record any other Events +from agentops import record, ActionEvent +record(ActionEvent("received_user_input")) +``` ## Integrations 🦾