Skip to content

Repository files navigation

💨 Velocity

A super fast API Wrapper for Perspective.

Requirements

  • Node >= 16
  • Perspective API Access

Installation

Install using one of these commands (depending on your package manager):

npm i velocity-api
pnpm i velocity-api
yarn add velocity-api

Example Usage

  • Note: This is a basic usage guide.

Typescript:

import{Velocity}from'velocity-api';(async()=>{constmanager=newVelocity('PERSPECTIVE_API_KEY');constscores=awaitmanager.processMessage("I don't like you!",{attributes: ['SPAM','SEVERE_TOXICITY'],languages: ['en'],doNotStore: true,});// The returned value is an object of the attributes and their score.console.log(scores.SPAM);console.log(scores.SEVERE_TOXICITY);})();

Javascript:

const{ Velocity }=require('velocity-api');(async()=>{constmanager=newVelocity('PERSPECTIVE_API_KEY');constscores=awaitmanager.processMessage("I don't like you!",{attributes: ['SPAM','SEVERE_TOXICITY'],languages: ['en'],doNotStore: true,});// The returned value is an object of the attributes and their score.console.log(scores.SPAM);console.log(scores.SEVERE_TOXICITY);})();

License

This repository is licensed under the Apache 2.0 License.

About

💨 A super fast API Wrapper for Perspective

Topics

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages