beliefsAbout · Umwelt docs

Reference/Queries/beliefsAbout

beliefsAboutquerysince 0.1

What one holder thinks another knows, set against what the other really holds.

Command lineTypeScript.NET

Request

umwelt call story.umw beliefsAbout '{
  "projectId": "ball",
  "holder": "bob",
  "about": "ana",
  "at": { "tick": 5 }
}'

Request

const result = await client.beliefsAbout({ projectId: 'ball', holder: 'bob', about: 'ana', at: { tick: 5 } });

Request

var result = engine.BeliefsAbout(new BeliefsAboutPayload
{
    ProjectId = "ball",
    Holder = "bob",
    About = "ana",
    At = new At { Tick = 5 },
});

Response

[
  {
    "actuallyHolds": true,
    "attitude": "believes",
    "confidence": 0.7,
    "polarity": false,
    "recordId": "bob-thinks-ana-blind",
    "actualRecordId": "ana-saw",
    "claimKey": "9190cc6f09646e8a3c8a74744d3e40477182a00d36dfdaa214b9fcdb99b0f5dd"
  }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`holder`required	string	Who holds the beliefs.
`about`required	string	The holder those beliefs are about.
`at`	Atdefault {}	Where to read: `tick`, an optional `axis`, and `asOfVersion`. Defaults to the latest.
`timelineId`	stringdefault "main"	The timeline to read.

Result

A list of BeliefAboutItem, each with:

Field	Type	Description
`recordId`always	string	The holder’s `umwelt:holds` Holding.
`claimKey`always	string	The claim the belief is about.
`polarity`always	boolean	True: they think the other holds the claim. False: they think not.
`attitude`always	"knows" \| "believes" \| "suspects" \| "remembers"	How the belief is held.
`confidence`always	number	Between 0 and 1.
`actuallyHolds`always	boolean	Whether the other really holds the claim at the same position (active and available).
`actualRecordId`	string	The other’s Holding, when there is one.

Rules

Second-order knowledge is a Holding. It is written as a Holding with the reserved predicate umwelt:holds, subject the other holder and value { "claimKey": … }.

Both sides are read at the same position. A belief is compared with what the other holds at at, never later.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project, a holder or the timeline does not exist, or the draft read was purged.

INVALID_STATEThe timeline read is a draft that was promoted. details.promotedInto names the timeline to read instead.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also