Evidence programs · StartupBuilder

Reference for Evidence.

Noun	System	Run by
Evidence	Discovery	Researcher

Evidence.create

Creates an Evidence. Verb page.

Text

do: return await $.Evidence.create(input)

Emits Evidence.created.

Inputs

Input	Type	Required	Description
`grade`	`string`	required	One of `Behavior`, `Commitment`, or `Opinion`. An Opinion weighs zero.
`quote`	`text`		The words or reading, verbatim.
`source`	`string`		Who or what it came from: an Interview, an Experiment, or a Metric reading.
`binds`	`string`		The slot it grades, as `Hypothesis#<slot>`.
`force`	`string`		One of `push`, `pull`, `anxiety`, or `habit`: the switching force it shows.
`observedAt`	`datetime`		When it was observed.
`distinctIcpMembers`	`integer`		How many distinct ICP members it represents.
`outside`	`boolean`		Computed: true when its source shares no owner, Studio account, Agreement, or sibling chain with the Startup.
`askedBy`	Party		The Customer or Contact who asked through an App, the Portal or an Agent; their ask is Opinion grade.
`stance`	`string`		Whether it supports or refutes the slot it binds; a cancel refutes the slot its reason tests.
`interview`	Interview		An Interview captures quotes and commitments, each graded as Evidence.

Returns

Output	Type	Required	Description
`evidence`	Evidence	required	The Evidence.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Evidence.create({ grade: 'Behavior' })"
  }
}

Returns one Evidence by id. Verb page.

Text

do: return await $.Evidence.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Evidence.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`evidence`	Evidence	required	The Evidence.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Evidence.get({ id: 'evidence_6xsa6iYImd' })"
  }
}

Returns Evidence, newest first, one page at a time. Verb page.

Text

do: return await $.Evidence.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`evidence`	list of Evidence	required	One page of Evidence.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Evidence.list({ limit: 20 })"
  }
}