Skip to content

Commit fb97f9a

Browse files
authored
Update README.md
1 parent e81c859 commit fb97f9a

File tree

1 file changed

+54
-54
lines changed

1 file changed

+54
-54
lines changed

apps/agent-scheduler/README.md

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,52 @@ Agent Scheduler is a sophisticated application designed to manage scheduling ope
1010
## Overview
1111
The Agent Scheduler is built to facilitate dynamic scheduling tasks by interpreting natural language inputs. It uses AI models to determine the type of scheduling action required, such as adding, cancelling, or listing tasks. The application is structured around a central `SchedulerAgent` class that manages the state and operations of scheduling tasks.
1212

13+
## Architecture
14+
The Agent Scheduler is an application that uses a combination of AI models and a durable object pattern to manage scheduling tasks. The core component is the `SchedulerAgent`, which handles the state and logic for scheduling operations.
15+
16+
### System Diagram
17+
```mermaid
18+
graph TD;
19+
A[User Query] -->|POST /query| B{SchedulerAgent}
20+
B -->|Determine Action| C[AI Model]
21+
C -->|Extract Action Type| D[Schedule Management]
22+
D -->|Add/Cancel/List| E[Confirmation]
23+
E -->|POST /confirmations/:confirmationId| F[User Confirmation]
24+
```
25+
26+
### Agentic Patterns
27+
The project employs several agentic patterns:
28+
29+
#### Tool Use Pattern
30+
The SchedulerAgent dynamically interacts with external AI models to interpret user queries and determine scheduling actions.
31+
32+
```mermaid
33+
graph TD;
34+
A[User Query] --> B{SchedulerAgent}
35+
B -->|Invoke AI Model| C[AI Model]
36+
C -->|Return Action Type| D[SchedulerAgent]
37+
```
38+
39+
#### Planning Pattern
40+
The SchedulerAgent formulates and executes plans based on user queries, aligning with real-time goals.
41+
42+
```mermaid
43+
graph TD;
44+
A[User Query] --> B{SchedulerAgent}
45+
B -->|Define Goal| C[Plan Execution]
46+
C -->|Execute Plan| D[Schedule Management]
47+
```
48+
49+
#### Autonomous Agent
50+
The SchedulerAgent operates autonomously, managing tasks dynamically and seeking feedback from the environment.
51+
52+
```mermaid
53+
graph TD;
54+
A[User Query] --> B{SchedulerAgent}
55+
B -->|Autonomous Operation| C[Task Management]
56+
C -->|Feedback Loop| D[User Interaction]
57+
```
58+
1359
## Usage
1460
To start the project locally, use the following command:
1561
```
@@ -18,31 +64,31 @@ npx nx dev agent-scheduler
1864

1965
### NPM Scripts
2066
- **deploy**: Deploys the application using Wrangler.
21-
```
67+
```
2268
npx nx deploy agent-scheduler
2369
```
2470
- **dev**: Starts the development server.
25-
```
71+
```
2672
npx nx dev agent-scheduler
2773
```
2874
- **lint**: Lints the codebase and throws errors on warnings.
29-
```
75+
```
3076
npx nx lint agent-scheduler
3177
```
3278
- **start**: Starts the development server.
33-
```
79+
```
3480
npx nx start agent-scheduler
3581
```
3682
- **test**: Runs the test suite.
37-
```
83+
```
3884
npx nx test agent-scheduler
3985
```
4086
- **test:ci**: Runs the test suite in CI mode.
41-
```
87+
```
4288
npx nx test:ci agent-scheduler
4389
```
4490
- **type-check**: Checks TypeScript types without emitting files.
45-
```
91+
```
4692
npx nx type-check agent-scheduler
4793
```
4894

@@ -107,50 +153,4 @@ The application exposes the following API endpoints:
107153
http://localhost:8787/confirmations/your-confirmation-id
108154
```
109155

110-
## Architecture
111-
The Agent Scheduler is an application that uses a combination of AI models and a durable object pattern to manage scheduling tasks. The core component is the `SchedulerAgent`, which handles the state and logic for scheduling operations.
112-
113-
### System Diagram
114-
```mermaid
115-
graph TD;
116-
A[User Query] -->|POST /query| B{SchedulerAgent}
117-
B -->|Determine Action| C[AI Model]
118-
C -->|Extract Action Type| D[Schedule Management]
119-
D -->|Add/Cancel/List| E[Confirmation]
120-
E -->|POST /confirmations/:confirmationId| F[User Confirmation]
121-
```
122-
123-
### Agentic Patterns
124-
The project employs several agentic patterns:
125-
126-
#### Tool Use Pattern
127-
The SchedulerAgent dynamically interacts with external AI models to interpret user queries and determine scheduling actions.
128-
129-
```mermaid
130-
graph TD;
131-
A[User Query] --> B{SchedulerAgent}
132-
B -->|Invoke AI Model| C[AI Model]
133-
C -->|Return Action Type| D[SchedulerAgent]
134-
```
135-
136-
#### Planning Pattern
137-
The SchedulerAgent formulates and executes plans based on user queries, aligning with real-time goals.
138-
139-
```mermaid
140-
graph TD;
141-
A[User Query] --> B{SchedulerAgent}
142-
B -->|Define Goal| C[Plan Execution]
143-
C -->|Execute Plan| D[Schedule Management]
144-
```
145-
146-
#### Autonomous Agent
147-
The SchedulerAgent operates autonomously, managing tasks dynamically and seeking feedback from the environment.
148-
149-
```mermaid
150-
graph TD;
151-
A[User Query] --> B{SchedulerAgent}
152-
B -->|Autonomous Operation| C[Task Management]
153-
C -->|Feedback Loop| D[User Interaction]
154-
```
155-
156-
<!-- Last updated: 7464b99c788378d693a45c25b97b3bbd024699c6 -->
156+
<!-- Last updated: 7464b99c788378d693a45c25b97b3bbd024699c6 -->

0 commit comments

Comments
 (0)