Samy\Paraphrase\TinqAi Class Reference

Inheritance diagram for Samy\Paraphrase\TinqAi:

Public Member Functions
	__construct (string $ApiKey)
	withTier (int $Tier)
	getTier ()
	withUnique (bool $Unique)
	getUnique ()
	getCharactersLeft ()
	getRequestsLeft ()
	getCreditsLeft ()
	getSupportedLanguages ()
	getSupportedModes ()
	paraphrase ()
Public Member Functions inherited from Samy\Paraphrase\AbstractParaphrase
	getSupportedLanguages ()
	getSupportedModes ()
	paraphrase ()
	withLanguage (string $Language)
	getLanguage ()
	withMode (int $Mode)
	getMode ()
	withText (string $Text)
	getText ()
	withLanguage (string $Language)
	getLanguage ()
	getSupportedLanguages ()
	withMode (int $Mode)
	getMode ()
	getSupportedModes ()
	withText (string $Text)
	getText ()
	paraphrase ()

Public Attributes
const	TIER_FREE = 0
const	TIER_STARTER = 1
const	TIER_PRO = 2
const	TIER_ULTRA = 3
const	TIER_SCALE = 4
const	MODE_NORMAL = 0
const	MODE_STANDARD = 1
const	MODE_FLUENT = 2
const	MODE_CREATIVE = 3

Protected Attributes
	$api_key = ""
	$characters_left = 0
	$requests_left = 0
	$credits_left = 0
	$unique = false
	$tier = 0
	$characters_request = 0
Protected Attributes inherited from Samy\Paraphrase\AbstractParaphrase
	$language = ""
	$mode = 0
	$text = ""

Additional Inherited Members
Protected Member Functions inherited from Samy\Paraphrase\AbstractParaphrase
	splitTextCharacter (int $Limit)
	getSentences ()
	request (string $Method, string $EndPoint, array $Headers, string $Content)

Detailed Description

Simple Tinq AI implementation.

Constructor & Destructor Documentation

__construct()

Samy\Paraphrase\TinqAi::__construct

(

string

$ApiKey

)

TinqAi construction.

Parameters

[in]

string

$ApiKey

Tinq AI API Key

Returns

void

Member Function Documentation

getCharactersLeft()

Samy\Paraphrase\TinqAi::getCharactersLeft

(

)

Retrieve characters left usage.

Returns

int

getCreditsLeft()

Samy\Paraphrase\TinqAi::getCreditsLeft

(

)

Retrieve credits left usage.

Returns

int

getRequestsLeft()

Samy\Paraphrase\TinqAi::getRequestsLeft

(

)

Retrieve requests left usage.

Returns

int

getSupportedLanguages()

Samy\Paraphrase\TinqAi::getSupportedLanguages

(

)

Retrieve supported languages.

Returns

array<array<string, string>>

Reimplemented from Samy\Paraphrase\AbstractParaphrase.

getSupportedModes()

Samy\Paraphrase\TinqAi::getSupportedModes

(

)

Retrieve supported modes.

Returns

array<array<string, mixed>>

Reimplemented from Samy\Paraphrase\AbstractParaphrase.

getTier()

Samy\Paraphrase\TinqAi::getTier

(

)

Retrieve provided tier.

Returns

int

getUnique()

Samy\Paraphrase\TinqAi::getUnique

(

)

Retrieve provided unique feature.

Returns

bool

paraphrase()

Samy\Paraphrase\TinqAi::paraphrase

(

)

Retrieve paraphrased text.

Returns

string

Reimplemented from Samy\Paraphrase\AbstractParaphrase.

withTier()

Samy\Paraphrase\TinqAi::withTier

(

int

$Tier

)

Return an instance with provided tier.

Parameters

[in]

int

$UniqueThe

unique feature

Returns

static

withUnique()

Samy\Paraphrase\TinqAi::withUnique

(

bool

$Unique

)

Return an instance with online plagiarism tests. Feature available for Pro users and up.

Parameters

[in]

bool

$Unique

The unique feature

Returns

static

Member Data Documentation

$api_key

Samy\Paraphrase\TinqAi::$api_key = ""

protected

describe api key

$characters_left

Samy\Paraphrase\TinqAi::$characters_left = 0

protected

describe characters left usage

$characters_request

Samy\Paraphrase\TinqAi::$characters_request = 0

protected

describe characters request limit

$credits_left

Samy\Paraphrase\TinqAi::$credits_left = 0

protected

describe credits left usage

$requests_left

Samy\Paraphrase\TinqAi::$requests_left = 0

protected

describe requests left usage

$tier

Samy\Paraphrase\TinqAi::$tier = 0

protected

describe tier

$unique

Samy\Paraphrase\TinqAi::$unique = false

protected

describe unique feature

MODE_CREATIVE

const Samy\Paraphrase\TinqAi::MODE_CREATIVE = 3

describe constant creative mode

MODE_FLUENT

const Samy\Paraphrase\TinqAi::MODE_FLUENT = 2

describe constant fluent mode

MODE_NORMAL

const Samy\Paraphrase\TinqAi::MODE_NORMAL = 0

describe constant normal mode

MODE_STANDARD

const Samy\Paraphrase\TinqAi::MODE_STANDARD = 1

describe constant standard mode

TIER_FREE

const Samy\Paraphrase\TinqAi::TIER_FREE = 0

describe constant free tier

TIER_PRO

const Samy\Paraphrase\TinqAi::TIER_PRO = 2

describe constant pro tier

TIER_SCALE

const Samy\Paraphrase\TinqAi::TIER_SCALE = 4

describe constant scale tier

TIER_STARTER

const Samy\Paraphrase\TinqAi::TIER_STARTER = 1

describe constant starter tier

TIER_ULTRA

const Samy\Paraphrase\TinqAi::TIER_ULTRA = 3

describe constant ultra tier

---

The documentation for this class was generated from the following file:

• paraphrase/TinqAi.php