Skip to content

Commit bbd4d00

Browse files
committed
readme: update user and dev md
1 parent c130388 commit bbd4d00

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/dev.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@
1212

1313
## Testing the Chat Function
1414

15-
To test your function, you can either call the code directly through a python script. Or you can build the respective chat function docker container locally and call it through an API request. Below you can find details on those processes.
15+
To test your function, you can run the unit tests, call the code directly through a python script, or build the respective chat function docker container locally and call it through an API request. Below you can find details on those processes.
16+
17+
### Run Unit Tests
18+
19+
You can run the unit tests using `pytest`.
20+
21+
```bash
22+
pytest
23+
```
1624

1725
### Run the Chat Script
1826

@@ -22,9 +30,9 @@ You can run the Python function itself. Make sure to have a main function in eit
2230
python src/module.py
2331
```
2432

25-
You can also use the `testbench_agents.py` script to test the agents with example inputs from Lambda Feedback questions and synthetic conversations.
33+
You can also use the `manual_agent_run.py` script to test the agents with example inputs from Lambda Feedback questions and synthetic conversations.
2634
```bash
27-
python src/agents/utils/testbench_agents.py
35+
python tests/manual_agent_run.py
2836
```
2937

3038
### Calling the Docker Image Locally
@@ -62,7 +70,7 @@ curl --location 'http://localhost:8080/2015-03-31/functions/function/invocations
6270
#### Call Docker Container
6371
##### A. Call Docker with Python Requests
6472
65-
In the `src/agents/utils` folder you can find the `requests_testscript.py` script that calls the POST URL of the running docker container. It reads any kind of input files with the expected schema. You can use this to test your curl calls of the chatbot.
73+
In the `tests/` folder you can find the `manual_agent_requests.py` script that calls the POST URL of the running docker container. It reads any kind of input files with the expected schema. You can use this to test your curl calls of the chatbot.
6674
6775
##### B. Call Docker Container through API request
6876
@@ -89,7 +97,6 @@ Body with optional Params:
8997
"conversational_style":" ",
9098
"question_response_details": "",
9199
"include_test_data": true,
92-
"agent_type": {agent_name}
93100
}
94101
}
95102
```

0 commit comments

Comments
 (0)