LLM-Captcha Package

LLM-Captcha is an npm package designed to help developers integrate a user verification system into their projects to distinguish between humans and AI bots. This package interacts with the LLM-Captcha backend service to provide a seamless verification flow.

Features

Customizable Question Set: Configure the number of questions to verify users.

Secure API Key Authentication: Use an API key to authenticate requests to the LLM-Captcha backend.

AI-Powered Verification: Calls an AI agent to determine if the user is human or a bot based on their responses.

Simple Integration: Easy-to-use methods to set up and manage the verification flow.

Installation

Install the package using npm or yarn:

npm install llm-captcha

or

yarn add llm-captcha

Usage

Configuration

Before using the package, you need an API key from the LLM-Captcha backend. Sign up and manage your API keys on the LLM-Captcha dashboard.

Basic Example

import { LLMCaptcha } from 'llm-captcha-package';

const llmCaptcha = new LLMCaptcha({
  apiKey: 'your-api-key-here',
  totalQuestions: 3, // Number of questions for verification
});

// Generate verification questions
async function initializeCaptcha() {
  const questions = await llmCaptcha.getQuestions();
}

// verify api key
async function verifyApiKey() {
  const result = await llmCaptcha.verifySecret();
  if (result.success) {
    console.log('API key is valid.');
  } else {
    console.log('Invalid API key.');
  }
}

// Verify user responses
async function verifyUserResponses(userResponses) {
  const result = await llmCaptcha.verifyAnswer(userResponses);
  if (result.isHuman) {
    console.log('User is verified as a human.');
  } else {
    console.log('User verification failed. They might be a bot.');
  }
}

initializeCaptcha();

API Methods

new LLMCaptcha(config)

Create an instance of the LLMCaptcha class.

Parameters:

• config (Object):

  • apiKey (string): Your API key for authenticating with the LLM-Captcha backend.
  • totalQuestions (number): Number of questions to generate for verification. Default is 5 questions
  • baseUrl (string): The base URL of the LLM-Captcha backend. Default is "https://llm-captcha-api.defikit.net".

getQuestions()

A set of verification questions.

Returns:

• Promise: An array of question objects.

  • verifyResponses(userResponses)

  • Verify user responses to the questions.

Parameters:

• userResponses (Array): An array of user responses to the questions.

Returns:

• Promise: Verification result object containing:

  • isHuman (boolean): Whether the user is verified as human.

  • message (string): Additional information about the verification result.

Best Practices

• Secure Your API Key: Ensure your API key is stored securely and not exposed in client-side code.

• Set Appropriate Question Count: Choose a reasonable number of questions to balance user experience and verification accuracy.

• Handle Verification Failures Gracefully: Provide clear feedback to users if verification fails.

Development and Support

For support, feature requests, or bug reports, please visit the LLM-Captcha GitHub repository.

License

This package is licensed under the MIT License.