addedOutput schema / properties / abstract
Added value: +{
+ "anyOf": [
+ {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "group": {
+ "description": "The section the term belongs to, e.g. Rent or Parties.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Machine name of the term, e.g. base_rent or security_deposit.",
+ "type": "string"
+ },
+ "label": {
+ "description": "Human-readable name of the term.",
+ "type": "string"
+ },
+ "quote": {
+ "description": "The words of the contract the value comes from, checked to appear in the document; may join two excerpts with \"...\". Null exactly when value is null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "value": {
+ "description": "The term as the contract states it (dates as YYYY-MM-DD, amounts with currency and period). Null when the contract does not state it: Prism never infers or computes an abstract term.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "key",
+ "label",
+ "group",
+ "value",
+ "quote"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The contract's key terms (parties, premises, area, dates, rent, deposit, permitted use, options, insurance limits and so on for a lease; the equivalent for a mortgage, insurance policy, HOA document or service agreement), each with the sentence it came from. Part of a full result only. Null on a preview, and null for a document type Prism has no abstract for. A term the contract does not state is listed with a null value."
+}
addedOutput schema / properties / abstractWithheld
Added value: +{
+ "description": "true when this contract has an abstract that this preview is holding back; unlocking returns it.",
+ "type": "boolean"
+}
addedOutput schema / properties / amendedBy
Added value: +{
+ "description": "Amendments sent for this contract, oldest first.",
+ "items": {
+ "$ref": "#/properties/amends/anyOf/0"
+ },
+ "type": "array"
+}
addedOutput schema / properties / amends
Added value: +{
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "contractId": {
+ "description": "Prism id of the contract.",
+ "type": "string"
+ },
+ "name": {
+ "description": "File name or title of the contract.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "contractId",
+ "name"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The contract this one amends; null when it is not an amendment. An amendment is read together with the contract it amends and every earlier amendment, so its deadlines show the contract as amended."
+}
changedOutput schema / properties / code / description
Previous value: -"Why full results were not delivered on this call: insufficient_credits when an unlock found no credits and withheldFacts is above 0 (call prism_buy_credits). null otherwise, including a preview that already shows every fact, where credits would unlock nothing."New value: +"Why full results were not delivered on this call: insufficient_credits when an unlock found no credits and either withheldFacts is above 0 or abstractWithheld is true (call prism_buy_credits). null otherwise, including a preview that already shows every fact and has no abstract to withhold, where credits would unlock nothing."
addedOutput schema / properties / supersededBy
Added value: +{
+ "anyOf": [
+ {
+ "$ref": "#/properties/amends/anyOf/0"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Set when a later amendment has been read and paid for: that amendment holds the current deadlines, and this contract shows the terms as they stood before it. Read and act on the amendment."
+}
changedOutput schema / required
Previous value: -[
- "contractId",
- "name",
- "status",
- "reviewUrl",
- "nextStep",
- "documentType",
- "summary",
- "access",
- "deadlines",
- "risks",
- "withheldFacts",
- "billing",
- "code",
- "failureReason"
-]New value: +[
+ "contractId",
+ "name",
+ "status",
+ "reviewUrl",
+ "nextStep",
+ "documentType",
+ "summary",
+ "access",
+ "deadlines",
+ "risks",
+ "withheldFacts",
+ "abstract",
+ "abstractWithheld",
+ "billing",
+ "code",
+ "failureReason"
+]