Skip to main content
POST
Correct an inference

Authorizations

Authorization
string
header
required

nia_sk_...

Path Parameters

profile_id
string<uuid>
required
key
string
required

Body

application/json

The value the subject says instead: a stated preference, or a stated attribute for an inferred size (source: correction). The inference it corrects is deleted. An interest is deleted, not corrected.

value
required
reason
string | null
Required string length: 1 - 500

Response

Successful Response

One thing the signals infer about the subject, with what it rests on: the subject can see it, correct it and delete it. What the subject said is not an inference, and is not listed.

at
string<date-time>
required

When its latest evidence happened.

key
string
required

A keyed hash that names the inference; it never carries its value.

Required string length: 1 - 512
kind
enum<string>
required

soft_constraint when the constraints block carries it as a soft entry, attribute for the inferred size, affinity for a value with evidence and no entry yet, interest for an object, instruction for what the subject said must or must not be done about an object (ref, the words in value): said, not inferred, and listed so a correction can withdraw it.

Available options:
affinity,
soft_constraint,
attribute,
interest,
instruction
origin
string
required

interactions, implicit_negative (shown often and never engaged with), or why an interest was kept: engaged, feedback, watch.

Required string length: 1 - 256
attr
string | null

The field whose value is inferred.

Pattern: ^[a-z][a-z0-9_]{0,39}\.[a-z][a-z0-9_]{0,63}$
confidence
number | null
evidence
Evidence · object

What it rests on, as counts: effective exposure, weighted signal, events, sessions and lift for a value; times for an interest.

for
string
default:self
Pattern: ^(?:self|gift|beneficiary:[A-Za-z0-9_-]{1,64})$
polarity
enum<string> | null
Available options:
prefer,
avoid
ref
string | null

The object of an interest.

Pattern: ^[a-z][a-z0-9_]{0,39}:[^:\s]{1,256}:\S{1,512}$
used_for
string[]

The purposes it is used for.

Required string length: 1 - 256
value