From ebf7017da56d05630715f3de5f71dd58f0948372 Mon Sep 17 00:00:00 2001 From: "Peter.Morton" Date: Fri, 25 Apr 2025 17:27:24 -0500 Subject: [PATCH] Adding basic-messenger-cli to README --- Applications/basic-messenger-cli/README.md | 48 ++++------------------ 1 file changed, 9 insertions(+), 39 deletions(-) diff --git a/Applications/basic-messenger-cli/README.md b/Applications/basic-messenger-cli/README.md index 0647e68..1d1229f 100644 --- a/Applications/basic-messenger-cli/README.md +++ b/Applications/basic-messenger-cli/README.md @@ -1,61 +1,31 @@ -# Node Chat CLI +# Basic Messenger CLI ## Overview -Node Chat CLI is a command line chat program that allows users to interact with OpenAI's API using the o4-mini model. Users can maintain multiple conversations, choose to start new conversations, or continue previous ones. -## Features -- Start a new conversation -- Continue existing conversations -- Store and retrieve conversation history -- Interact with OpenAI's API for responses +Basic Messenger CLI is a command line chat program that allows users to interact with IVA Studio's basic-messenger API. ## Installation -1. Clone the repository: - ``` - git clone - ``` +1. Install the dependencies: -2. Navigate to the project directory: - ``` - cd node-chat-cli - ``` - -3. Install the dependencies: ``` npm install ``` -4. Create a `.env` file in the root directory and add your OpenAI API key: +2. Create a `.env` file in the root directory and add your END_POINT and MODEL: ``` - OPENAI_API_KEY=your_api_key_here + END_POINT=https://router.ivastudio.verint.live/ProxyScript/run/67bca862210071627d32ef12/current/basic_messenger + MODEL=main ``` ## Usage To start the application, run: + ``` -node src/index.js +node start ``` -Follow the prompts to start a new conversation or continue an existing one. - -## Example - -1. Start a new conversation: - ``` - > Start a new conversation - ``` - -2. Continue a previous conversation: - ``` - > Continue conversation with ID 1 - ``` - -## Contributing - -Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements. - ## License -This project is licensed under the MIT License. \ No newline at end of file +This project is licensed under the MIT License.