- This Node.js module simplifies interaction with the Undetectable AI Detection API. It allows developers to easily detect AI-generated text within their applications.
- Features
- Installation
- Prerequisites
- Getting Started
- Importing the Module
- Initializing the API Client
- Usage
- Detecting Human Text
- Detecting Individual Human Text
- API Reference
- UndetectableApi Class
- detectHumanText(text)
- detectIndividualHumanText(text)
- Error Handling
- Examples
- Contributing
- License
- Easy Integration: Simplifies interaction with the Undetectable API.
- Text Detection: Detects AI-generated content in text.
- Individual Detection: Allows detection using various third-party AI detectors.
- Promise-Based: Uses async/await for clean and readable code.
- TypeScript Support: Fully typed for a better development experience.
Install the package via npm:
Bash
npm install undetectable-api
If the package is not published on npm, you can include the source code directly by copying the undetectableApi.ts file and related modules into your project directory.
- Node.js version 12 or higher.
- TypeScript (optional) if you want to use the module with TypeScript.
- API Key from Undetectable.ai.
JavaScript
const { UndetectableApi } = require('undetectable-api');
TypeScript
import { UndetectableApi } from 'undetectable-api';
TypeScript
import { UndetectableApi } from './src/undetectableApi';
Create an instance of the UndetectableApi class using your API key:
TypeScript
const apiKey = 'your-api-key-here';
const undetectableApi = UndetectableApi.getInstance(apiKey);
Use the detectHumanText method to submit text for AI detection:
TypeScript
const text = 'Sample text to analyze for AI-generated content.';
try {
const response = await undetectableApi.detectHumanText(text);
console.log('Detection Result:', response);
} catch (error) {
console.error('Error:', error.message);
}
Use the detectIndividualHumanText
method to submit text for detection by various third-party AI detectors:
TypeScript
const text = 'Sample text to analyze using individual detectors.';
try {
const response = await undetectableApi.detectIndividualHumanText(text);
console.log('Individual Detection Result:', response);
} catch (error) {
console.error('Error:', error.message);
}
UndetectableApi
Class
detectHumanText(text)
- Description: Submits text for AI detection.
- Parameters:
text
(string): The text to analyze.
- Returns:
Promise<DetectApiResponse>
- Usage:
TypeScript
const response = await undetectableApi.detectHumanText(text);
detectIndividualHumanText(text)
- Description: Submits text for detection by various third-party AI detectors.
- Parameters:
text
(string): The text to analyze.
- Returns: Promise
- Usage:
TypeScript
const response = await undetectableApi.detectIndividualHumanText(text);
Errors are thrown as instances of Error
with descriptive messages. Common error