Class: ParaphraseService

ParaphraseService()

Paraphrase and Simplify are available as two different flavors of the same module. While the Paraphrase module attempts to change the wording while keeping the same level of complexity, the Simplify module outputs more commonly used words without altering the meaning of the original text.

Constructor

new ParaphraseService()

Source:

Methods

call(user, text, engineopt) → {Promise.<Object>}

Parameters:
Name Type Attributes Default Description
user string The ID of the user accessing the Soffos API. Soffos assumes that the owner of the api is an application (app) and that app has users. Soffos API will accept any string.
text string Text to be paraphrased/simplified.
engine string <optional>
 null The LLM engine to be used.
Source:
Returns:
paraphrase
Type
Promise.<Object>
Example
import { SoffosServices } from "soffosai";

const my_apiKey = "Token <put your api key here>";
const service = new SoffosServices.ParaphraseService({apiKey:my_apiKey});
let response = await service.call(
    "sample client id", 
    "Soffosai provides a very easy and economical way to integrate AI into your systems"
);
console.log(JSON.stringify(response, null, 2));
    
// returns
// {
//     "paraphrase": "Soffosai offers a simple and cost-effective method for incorporating AI into your systems",
//     "simplify": false,
//     "cost": {
//       "api_call_cost": 0.005,
//       "character_volume_cost": 0.005,
//       "total_cost": 0.01
//     },
//     "charged_character_count": 100,
//     "unit_price": "0.000050"
// }

setInputConfigs(name, text, engineopt)

Parameters:
Name Type Attributes Default Description
name string Reference name of this Service. It will be used by the Pipeline to reference this Service.
text string | InputConfig Text to be paraphrased/simplified.
engine string <optional>
 null The LLM engine to be used.
Source: