mirror of
https://github.com/katanemo/plano.git
synced 2026-05-08 23:32:43 +02:00
updated all demo READMes and minor doc changes (#154)
* updated all demo READMes and minor doc changes * minor typo fixes * updated main Readme * fixed README and docs * fixed README and docs --------- Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
This commit is contained in:
parent
b63a01fe82
commit
42d4a28e13
22 changed files with 324 additions and 1455 deletions
|
|
@ -1 +1,64 @@
|
|||
The following demo
|
||||
# Insurance Agent Demo
|
||||
|
||||
This demo showcases how the **Arch** can be used to manage insurance-related tasks such as policy inquiries, initiating policies, and updating claims or deductibles. In this demo, the assistant provides factual information related to insurance policies (e.g., car, boat, house, motorcycle).
|
||||
|
||||
The system can perform a variety of tasks, such as answering insurance-related questions, retrieving policy coverage details, initiating policies, and updating claims or deductibles.
|
||||
|
||||
## Available Functions:
|
||||
|
||||
- **Policy Q/A**: Handles general Q&A related to insurance policies.
|
||||
- **Endpoint**: `/policy/qa`
|
||||
- This function answers general inquiries related to insurance, such as coverage details or policy types. It is the default target for insurance-related queries.
|
||||
|
||||
- **Get Policy Coverage**: Retrieves the coverage details for a given policy type (car, boat, house, motorcycle).
|
||||
- **Endpoint**: `/policy/coverage`
|
||||
- Parameters:
|
||||
- `policy_type` (required): The type of policy. Available options: `car`, `boat`, `house`, `motorcycle`. Defaults to `car`.
|
||||
|
||||
- **Initiate Policy**: Starts a policy coverage for car, boat, motorcycle, or house.
|
||||
- **Endpoint**: `/policy/initiate`
|
||||
- Parameters:
|
||||
- `policy_type` (required): The type of policy. Available options: `car`, `boat`, `house`, `motorcycle`. Defaults to `car`.
|
||||
- `deductible` (required): The deductible amount set for the policy.
|
||||
|
||||
- **Update Claim**: Updates the notes on a specific insurance claim.
|
||||
- **Endpoint**: `/policy/claim`
|
||||
- Parameters:
|
||||
- `claim_id` (required): The claim number.
|
||||
- `notes` (optional): Notes about the claim number for the adjustor to see.
|
||||
|
||||
- **Update Deductible**: Updates the deductible amount for a specific policy coverage.
|
||||
- **Endpoint**: `/policy/deductible`
|
||||
- Parameters:
|
||||
- `policy_id` (required): The ID of the policy.
|
||||
- `deductible` (required): The deductible amount to be set for the policy.
|
||||
|
||||
**Arch** is designed to intelligently routes prompts to the appropriate functions based on the target, allowing for seamless interaction with various insurance-related services.
|
||||
|
||||
# Starting the demo
|
||||
1. Create `.env` file and set OpenAI key using env var `OPENAI_API_KEY`
|
||||
2. Start Arch
|
||||
```sh
|
||||
archgw up [path to arch_config.yaml]
|
||||
```
|
||||
3. Start Network Agent
|
||||
```sh
|
||||
docker compose up
|
||||
```
|
||||
3. Navigate to http://localhost:18080/
|
||||
4. You can type in queries like "show me device statics for the past 7 days"
|
||||
|
||||
|
||||
# Observability
|
||||
Arch gateway publishes stats endpoint at http://localhost:19901/stats. In this demo we are using grafana to pull stats from
|
||||
arch and we are using grafana to visalize the stats in dashboard. To see grafana dashboard follow instructions below,
|
||||
|
||||
1. Start grafana and prometheus using following command
|
||||
```yaml
|
||||
docker compose --profile monitoring up
|
||||
```
|
||||
1. Navigate to http://localhost:3000/ to open grafana UI (use admin/grafana as credentials)
|
||||
1. From grafana left nav click on dashboards and select "Arch" to view the arch gateway stats
|
||||
|
||||
Here is sample interaction,
|
||||
<img width="575" alt="image" src="https://github.com/user-attachments/assets/25d40f46-616e-41ea-be8e-1623055c84ec">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue