Giter VIP home page Giter VIP logo

resort-chatbot's Introduction

Got it! Here's a polished version of your README with the provided instructions:


RESORT CHATBOT

Installation Instructions

  1. Run npm install

    At the base of the project directory, run the following command to install all necessary dependencies:

    npm install
  2. Generate OpenAI API Key

    • Generate an OpenAI API key from here.
  3. Create a .env File

    At the base of the project, create a .env file and add the following line, replacing <YOUR_OPENAI_API_KEY> with your actual OpenAI API key:

    OPENAI_API_KEY=<YOUR_OPENAI_API_KEY>

Running the Project

To run the project, use the following command:

node startup.js

Postman Collection

  1. Update Postman Collection

    Make sure your Postman collection is updated with the appropriate endpoints.

  2. Hit Chat API from Postman Collection

    To initiate a chat, send a request to the chat API. Example request:

    {
        "query": "Hi"
    }

    On the first response, you will receive a conversationId, which will be used for subsequent requests. Example:

    {
        "query": "I want to book a room",
        "conversationId": "b0ff22ad-8cab-4cbf-ba70-9afa94eb4a2"
    }

Example API Requests and Responses

Initial Request

{
    "query": "Hi"
}

Subsequent Request

{
    "query": "I want to book a room",
    "conversationId": "b0ff22ad-8cab-4cbf-ba70-9afa94eb4a2"
}

resort-chatbot's People

Contributors

mahak-juriani avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.