Documentation

AdvisorInsight extends BaseModel
in package

Table of Contents

Properties

$category  : string|null
$checkedAt  : string|null
$id  : int
$inspectorKey  : string
$isDismissed  : bool
$lastAiRun  : array<string|int, mixed>|null
$metrics  : array<string|int, mixed>
$outcome  : string|null
$payload  : array<string|int, mixed>|null
$recommendations  : array<string|int, mixed>
$refreshPolicy  : string|null
$severity  : string|null
$status  : string

Methods

__construct()  : mixed
getCategory()  : string|null
getCheckedAt()  : string|null
getId()  : int
getInspectorKey()  : string
getLastAiRun()  : array<string|int, mixed>|null
getMetrics()  : array<string|int, mixed>
getOutcome()  : string|null
getPayload()  : array<string|int, mixed>|null
getRecommendations()  : array<string|int, mixed>
getRefreshPolicy()  : string|null
getSeverity()  : string|null
getStatus()  : string
isDismissed()  : bool
setIsDismissed()  : void
Dismiss or reactivate the insight; send with AdvisorApi::updateInsight()

Properties

$recommendations

protected array<string|int, mixed> $recommendations

Methods

__construct()

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

getCategory()

public getCategory() : string|null
Return values
string|null

getCheckedAt()

public getCheckedAt() : string|null
Return values
string|null

getInspectorKey()

public getInspectorKey() : string
Return values
string

getLastAiRun()

public getLastAiRun() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —

mode, promptId, at

getMetrics()

public getMetrics() : array<string|int, mixed>
Return values
array<string|int, mixed> —

list of key, value, unit, threshold, tone, source, checkedAt

getOutcome()

public getOutcome() : string|null
Return values
string|null —

flagged, clear or not_applicable

getPayload()

public getPayload() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getRecommendations()

public getRecommendations() : array<string|int, mixed>
Return values
array<string|int, mixed> —

list of id, primary, params

getRefreshPolicy()

public getRefreshPolicy() : string|null
Return values
string|null —

hourly or daily

getSeverity()

public getSeverity() : string|null
Return values
string|null —

high, medium or low

getStatus()

public getStatus() : string
Return values
string —

pending, checking, outdated or done

setIsDismissed()

Dismiss or reactivate the insight; send with AdvisorApi::updateInsight()

public setIsDismissed(bool $isDismissed) : void
Parameters
$isDismissed : bool
On this page

Search results