Skip to content

Commit 4eec483

Browse files
committed
feat: update docs
1 parent 64d2f9c commit 4eec483

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ pip install -U agentserve
4444

4545
AgentServe allows you to easily wrap your agent code in a FastAPI application and expose it via REST endpoints. Below are the steps to integrate AgentServe into your project.
4646

47-
### 1.Install AgentServe
47+
### 1. Install AgentServe
4848

4949
First, install the `agentserve` package using pip:
5050

@@ -57,7 +57,7 @@ Make sure your virtual environment is activated if you're using one.
5757

5858
### 2. Create or Update Your Agent
5959

60-
Within your entry point file (e.g. `main.py`), create an agent function that will be used to process tasks.
60+
Within your entry point file (e.g. `main.py`) we will import `agentserve` and create an app instance, then decorate an agent function with `@app.agent`. Finally, we will call `app.run()` to start the server.
6161

6262
The agent function should take a single argument, `task_data`, which will be a dictionary of data prequired by your agent.
6363

@@ -66,6 +66,7 @@ The agent function should take a single argument, `task_data`, which will be a d
6666
```python
6767
# main.py
6868
import agentserve
69+
from openai import OpenAI
6970

7071
app = agentserve.app()
7172

@@ -84,7 +85,7 @@ if __name__ == "__main__":
8485
```
8586

8687
In this example:
87-
- We import agentserve and create an app instance using agentserve.app().
88+
- We import agentserve and create an app instance using `agentserve.app()`.
8889
- We define our agent function `my_agent` and decorate it with `@app.agent`.
8990
- Within the agent function, we implement our agent's logic.
9091
- We call `app.run()` to start the server.
@@ -249,6 +250,7 @@ INSTRUCTIONS COMING SOON
249250

250251
- [ ] Add support for streaming responses
251252
- [ ] Add easy instructions for more hosting options (GCP, Azure, AWS, etc.)
253+
- [ ] Add support for external storage for task results
252254
- [ ] Add support for multi model agents
253255
- [ ] Add support for more agent frameworks
254256

0 commit comments

Comments
 (0)