mirror/temporal-ai-agent
1
0
Fork 0
mirror of https://github.com/temporal-community/temporal-ai-agent.git synced 2026-03-15 14:08:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

updating docs and todo

Browse Source
This commit is contained in:
Joshua Smith
2025-03-19 07:49:06 -04:00
parent bd1cfbad01
commit c20f5d796f
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
adding-goals-and-tools.md
View File

@@ -3,12 +3,20 @@ The agent is set up to allow for multiple goals and to switch back to choosing a
It may be helpful to review the [architecture](./architecture.md) for a guide and definition of goals, tools, etc. It may be helpful to review the [architecture](./architecture.md) for a guide and definition of goals, tools, etc.
### Adding a New Goal Category
Goal Categories lets you pick which groups of goals to show. Set via an .env setting, GOAL_CATEGORIES.
1. Pick a unique one that has some business meaning
2. Use it in your .env file
3. Add to [.env.example](./.env.example)
4. Use it in your Goal definition, see below.
### Adding a Goal ### Adding a Goal
1. Open [/tools/goal_registry.py](tools/goal_registry.py) - this file contains descriptions of goals and the tools used to achieve them 1. Open [/tools/goal_registry.py](tools/goal_registry.py) - this file contains descriptions of goals and the tools used to achieve them
2. Pick a name for your goal! (such as "goal_hr_schedule_pto") 2. Pick a name for your goal! (such as "goal_hr_schedule_pto")
3. Fill out the required elements: 3. Fill out the required elements:
- `id`: needs to be the same as the name - `id`: needs to be the same as the name
- `agent_name`: user-facing name for the agent/chatbot - `agent_name`: user-facing name for the agent/chatbot
- `category_tag`: category for the goal
- `agent_friendly_description`: user-facing description of what the agent/chatbot does - `agent_friendly_description`: user-facing description of what the agent/chatbot does
- `tools`: the list of tools the goal will walk the user through. These will be defined in the [tools/tool_registry.py](tools/tool_registry.py) and should be defined in list form as tool_registry.[name of tool] - `tools`: the list of tools the goal will walk the user through. These will be defined in the [tools/tool_registry.py](tools/tool_registry.py) and should be defined in list form as tool_registry.[name of tool]
- Important! The last tool listed must be `list_agents_tool`. This allows the chatbot to guide the user back to choosing from the list of available goals once a goal is complete.<br /> - Important! The last tool listed must be `list_agents_tool`. This allows the chatbot to guide the user back to choosing from the list of available goals once a goal is complete.<br />

10
todo.md
View File

@@ -1,20 +1,20 @@
# todo list # todo list
[ ] add confirmation env setting to setup guide <br /> [ ] add confirmation env setting to setup guide <br />
<br /> <br />
[ ] how to add more scenarios, tools <br /> [x] how to add more scenarios, tools <br />
[ ] make agent respond to name of goals and not just numbers
[ ] L look at slides
[ ] josh to do fintech scenarios
[ ] create tests<br /> [ ] create tests<br />
[ ] fix logging statements not to be all warn, maybe set logging level to info [ ] fix logging statements not to be all warn, maybe set logging level to info
[ ] create people management scenarios <br /> [ ] create people management scenarios <br />
[ ] 2. Others: [ ] 2. Others HR goals:
-- check pay status <br />
-- book work travel <br /> -- book work travel <br />
-- check insurance coverages <br /> -- check insurance coverages <br />
-- expense management <br /> -- expense management <br />
-- check in on the health of the team <br /> -- check in on the health of the team <br />
-- check pto
[x] demo the reasons why: <br /> [x] demo the reasons why: <br />
- Orchestrate interactions across distributed data stores and tools <br /> - Orchestrate interactions across distributed data stores and tools <br />