mirror of
https://github.com/katanemo/plano.git
synced 2026-05-09 07:42:43 +02:00
add README for hr_agent (#224)
* add README for hr_agent * fixed sample prompt for hr_agent in README * added screenshot and updated README.md --------- Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
This commit is contained in:
parent
f88740582f
commit
ff6e9bd9bd
2 changed files with 31 additions and 0 deletions
31
demos/hr_agent/README.md
Normal file
31
demos/hr_agent/README.md
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
# HR Agent Demo
|
||||||
|
|
||||||
|
This demo showcases how the **Arch** can be used to build an HR agent to manage workforce-related inquiries, workforce planning, and communication via Slack. It intelligently routes incoming prompts to the correct targets, providing concise and useful responses tailored for HR and workforce decision-making.
|
||||||
|
|
||||||
|
## Available Functions:
|
||||||
|
|
||||||
|
- **HR Q/A**: Handles general Q&A related to insurance policies.
|
||||||
|
- **Endpoint**: `/agent/hr_qa`
|
||||||
|
|
||||||
|
- **Workforce Data Retrieval**: Retrieves data related to workforce metrics like headcount, satisfaction, and staffing.
|
||||||
|
- **Endpoint**: `/agent/workforce`
|
||||||
|
- Parameters:
|
||||||
|
- `staffing_type` (str, required): Type of staffing (e.g., `contract`, `fte`, `agency`).
|
||||||
|
- `region` (str, required): Region for which the data is requested (e.g., `asia`, `europe`, `americas`).
|
||||||
|
- `point_in_time` (int, optional): Time point for data retrieval (e.g., `0 days ago`, `30 days ago`).
|
||||||
|
|
||||||
|
- **Initiate Policy**: Sends messages to a Slack channel
|
||||||
|
- **Endpoint**: `/agent/slack_message`
|
||||||
|
- Parameters:
|
||||||
|
- `slack_message` (str, required): The message content to be sent
|
||||||
|
|
||||||
|
# Starting the demo
|
||||||
|
1. Please make sure the [pre-requisites](https://github.com/katanemo/arch/?tab=readme-ov-file#prerequisites) are installed correctly
|
||||||
|
2. Start Arch
|
||||||
|
```sh
|
||||||
|
sh run_demo.sh
|
||||||
|
```
|
||||||
|
3. Navigate to http://localhost:18080/
|
||||||
|
4. "Can you give me workforce data for asia?"
|
||||||
|
|
||||||
|

|
||||||
BIN
demos/hr_agent/image.png
Normal file
BIN
demos/hr_agent/image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 456 KiB |
Loading…
Add table
Add a link
Reference in a new issue