aiformvalidator

Overview

This package aims to use the ChatGPT AI to validate input form fields.This package further enhances protection against bad inputs and to also guide users on what to input in the form input fields.The package is currently only text-based,means only input types that have text only can be validated.The AI will validate the field based on user input and the type of the field provided by the developer.As the AI Model is intelligent, you can even include special instructions in the input field type like - fieldType="username.Please make sure the username is not obscene".

ChatGPT API Key

To use this package, you will need an OpenAI API key. Follow these steps to get your API key:

1. Go to the OpenAI API platform.
2. Sign up for an account or log in if you already have one.
3. After logging in, navigate to the API section of your dashboard.
4. Generate a new API key and copy it.

Now you can use this API key in your code to validate fields.

Code Usage

Here’s a simple example of how to use the validateField function:

const { validateField } = require('aiformvalidator');

(async () => {
const apiKey = "sk-your-openai-api-key"; // GPT API key
const fieldType = "email"; // The type of input field
const userInput = "example@example.com"; // The content of the input field
const modelType = "gpt-4"; // ChatGPT model type

try {
const result = await validateField(apiKey, modelType, fieldType, userInput);
console.log("Validation Result:", result);

// Check for "Passed" or "Denied"
if (result.includes("Passed")) {
console.log("Validation Passed!");
} else if (result.includes("Denied")) {
console.log("Validation Denied!");
} else {
console.log("Unexpected response:", result);
}

} catch (error) {
console.error("Error during validation:", error);
}
})();

Response format

All responses contain the words _'Passed'_ or _'Denied'_ to indicate the status of the validation. You can check if these words exist to set the validation status for your form accordingly.

Input field type

As AI is being used to validate the fields, you can specify something very specific for the input field type parameter like "USA mobile number" or "password with 3 uppercase letters and 4 numbers".Feel free to experiment!

Screenshot of Web Implementation

https://drive.google.com/file/d/1T9kpxlGlPol6SMNuq_mPyu04VGjQKg8S/view?usp=sharing