Refactored to flow Hub Packaging directory structures
This commit is contained in:
86
basic-messenger-cli/README.md
Normal file
86
basic-messenger-cli/README.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Basic Messenger
|
||||
|
||||
Built for PoCs with other Speech Services, this provides a simple text from a prompt interface for IVA Studio
|
||||
|
||||
## Prerequisits
|
||||
|
||||
1. Install and configure the _Core Messenger Webhook_ Package from the Resource Center -> Hub.
|
||||
|
||||
## Source Code
|
||||
|
||||
[basic_messenger](./_studio_dependencies/ProxyScript/basic_messenger.js) Proxy Script
|
||||
|
||||
## Example usage
|
||||
|
||||
```sh
|
||||
curl --location 'https://router.ivastudio.verint.live/ProxyScript/run/67bca862210071627d32ef12/current/basic_messenger' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"input" : "What is the weather",
|
||||
"model" : "main"
|
||||
}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "resp_c8191807-c478-41d0-a73c-68d361eae5a3",
|
||||
"object": "response",
|
||||
"created_at": 1745609535,
|
||||
"status": "completed",
|
||||
"model": "main",
|
||||
"output": [
|
||||
{
|
||||
"type": "message",
|
||||
"id": "msg_56594e02-ae08-47ce-8c7f-d5165b1fa9de",
|
||||
"role": "assistant",
|
||||
"content": [
|
||||
{
|
||||
"type": "output_text",
|
||||
"text": "Could you please provide a city or a zip code to get the weather information?",
|
||||
"annotations": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Note the use of "previous_response_id" to manage conversation state.
|
||||
|
||||
```sh
|
||||
curl --location 'https://router.ivastudio.verint.live/ProxyScript/run/67bca862210071627d32ef12/current/basic_messenger' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"input" : "Chicago",
|
||||
"model" : "main",
|
||||
"previous_response_id" : "resp_c8191807-c478-41d0-a73c-68d361eae5a3"
|
||||
}'
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "resp_c8191807-c478-41d0-a73c-68d361eae5a3",
|
||||
"object": "response",
|
||||
"created_at": 1745609627,
|
||||
"status": "completed",
|
||||
"model": "main",
|
||||
"output": [
|
||||
{
|
||||
"type": "message",
|
||||
"id": "msg_ef591b4c-b08b-49fe-85a5-306c94269bf6",
|
||||
"role": "assistant",
|
||||
"content": [
|
||||
{
|
||||
"type": "output_text",
|
||||
"text": "Can you provide the zip code for Chicago?",
|
||||
"annotations": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### CLI client for basic_messenger
|
||||
|
||||
You can find an example CLI client (using Node.js) [here](./application/)
|
||||
Reference in New Issue
Block a user