fadingNA / chat-completion-api

Chat Minal is a completion and some specific define prompt for user eg summarize, analze and more.
MIT License
2 stars 2 forks source link

chat-minal

The chat-minal is a command-line tool work on terminal that makes it easy to interact with the OpenAI Chat Completion API using Langchain. This tool allows you to send text prompts and receive AI-generated responses directly from the command line. You can customize the model, set parameters like temperature and token limits, and save the output to a file.

Added new feature 0.1.1 pre defined prompt user can select choice for make genAI running task without input text or prompt.

References Langchain Document

Demo walkthrough the chatminal

Demo Link chat-minal tutorial

Example of Usage

![Code Review in Chat Completion Tool](assets/code_reviews.png) *Figure 1: Code Review in Chat Completion Tool* ![Convert JSON to CSV](assets/convert_json_tocsv.png) *Figure 2: Converting JSON to CSV using the Tool* ![Generate Markdown from Text](assets/generate_markdown.png) *Figure 3: Generating Markdown from Text with Ease* ![Summarize Text](assets/summarize_text.png) *Figure 4: Summarizing Text in the Chat Completion Tool*

Overview

This tool allows you to interact with the ChatOpenAPI from Langchain via a command-line interface (CLI). You can provide input text, specify a model, and configure other parameters to generate chat completions.

Langchain is a Python or Javascript library that provide a flexibility to interact with OpenAI API. It allows you to generate completions for various tasks, such as chat, code, and text generation. You can use Langchain to build AI-powered applications, automate tasks, and enhance your projects with AI capabilities.

Features

Installation

  1. Clone the Repository:

    git clone https://github.com/fadingNA/chat-completion-api.git
    cd chat-completion-api
    pip install -r requirements.txt # if you are using pip3 change pip to pip3 instead.
    
    cd app # to run the play.py file or app/play.py

Usage

Options

Option Description
-h, --help, --howto Show the help message.
-v, --version Show the version of the tool.
--input_text, -i Input text to generate completion.
--output, -o Output file to save the generated completion.
--temperature, -t Temperature for the completion.
--max_tokens Maximum tokens for the completion.
--api_key, -a OpenAI API Key.
--model, -m Model for the completion.
--models List all available models on OpenAI.
--select_choices Will use a pre defined prompt
--token-usage Token usage for the completion.

Requirements

Table of Contributors

Name Blog Post (URL) GitHub Repo (URL) Language
Nonthachai Plodthong Blog Post GitHub Repo Python + SSH

License

This project is licensed under the MIT License - see the LICENSE file for details.