api.locus.report

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "A `kind`-discriminated union: `local_policy_brief` for paid cited policy context, or `policy_coverage_diagnostic` for a free pre-charge diagnostic.",
  "oneOf": [
    {
      "additionalProperties": {},
      "properties": {
        "artifacts": {
          "items": {
            "additionalProperties": {},
            "properties": {
              "actionDate": {
                "type": "string"
              },
              "actions": {
                "items": {},
                "type": "array"
              },
              "affectedDomains": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "affectedGeographies": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "artifactId": {
                "type": "string"
              },
              "artifactType": {
                "enum": [
                  "bill",
                  "session_law",
                  "statute",
                  "ordinance",
                  "resolution",
                  "agenda_item",
                  "code_section"
                ],
                "type": "string"
              },
              "caveats": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "citations": {
                "items": {
                  "additionalProperties": false,
                  "properties": {
                    "fetchedAt": {
                      "type": "string"
                    },
                    "locator": {
                      "type": "string"
                    },
                    "recordId": {
                      "type": "string"
                    },
                    "sourceName": {
                      "type": "string"
                    },
                    "sourceUrl": {
                      "format": "uri",
                      "type": "string"
                    }
                  },
                  "required": [
                    "sourceName",
                    "sourceUrl",
                    "fetchedAt",
                    "recordId"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "effectiveDate": {
                "type": "string"
              },
              "excerpts": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "introducedAt": {
                "type": "string"
              },
              "jurisdictionId": {
                "type": "string"
              },
              "jurisdictionName": {
                "type": "string"
              },
              "level": {
                "enum": [
                  "state",
                  "county",
                  "city"
                ],
                "type": "string"
              },
              "officialId": {
                "type": "string"
              },
              "rateChanges": {
                "items": {
                  "additionalProperties": {},
                  "properties": {
                    "deltaValue": {
                      "type": "number"
                    },
                    "extractedFrom": {
                      "enum": [
                        "title",
                        "summary",
                        "text"
                      ],
                      "type": "string"
                    },
                    "fromValue": {
                      "type": "number"
                    },
                    "kind": {
                      "enum": [
                        "property_tax",
                        "fee",
                        "levy",
                        "bond"
                      ],
                      "type": "string"
                    },
                    "label": {
                      "type": "string"
                    },
                    "sourceExcerpt": {
                      "type": "string"
                    },
                    "toValue": {
                      "type": "number"
                    },
                    "unit": {
                      "enum": [
                        "cents_per_100",
                        "usd",
                        "percent"
                      ],
                      "type": "string"
                    }
                  },
                  "required": [
                    "kind",
                    "label",
                    "unit",
                    "toValue",
                    "extractedFrom",
                    "sourceExcerpt"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "status": {
                "enum": [
                  "introduced",
                  "in_committee",
                  "adopted",
                  "enacted",
                  "codified",
                  "repealed",
                  "failed",
                  "not_published",
                  "unknown"
                ],
                "type": "string"
              },
              "summary": {
                "type": "string"
              },
              "textVersions": {
                "items": {},
                "type": "array"
              },
              "title": {
                "type": "string"
              },
              "votes": {
                "items": {},
                "type": "array"
              }
            },
            "required": [
              "artifactId",
              "jurisdictionId",
              "jurisdictionName",
              "level",
              "artifactType",
              "officialId",
              "title",
              "status",
              "textVersions",
              "actions",
              "votes",
              "affectedDomains",
              "affectedGeographies",
              "citations",
              "caveats"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "caveats": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "citations": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "fetchedAt": {
                "type": "string"
              },
              "locator": {
                "type": "string"
              },
              "recordId": {
                "type": "string"
              },
              "sourceName": {
                "type": "string"
              },
              "sourceUrl": {
                "format": "uri",
                "type": "string"
              }
            },
            "required": [
              "sourceName",
              "sourceUrl",
              "fetchedAt",
              "recordId"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "generatedAt": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "intent": {
          "type": "string"
        },
        "kind": {
          "const": "local_policy_brief",
          "type": "string"
        },
        "place": {
          "additionalProperties": false,
          "properties": {
            "displayName": {
              "type": "string"
            },
            "input": {
              "type": "string"
            },
            "jurisdictionIds": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "resolved": {
              "type": "string"
            }
          },
          "required": [
            "input",
            "jurisdictionIds"
          ],
          "type": "object"
        },
        "policyRulesetVersion": {
          "type": "string"
        },
        "refinement": {
          "additionalProperties": {},
          "properties": {
            "context": {
              "additionalProperties": false,
              "properties": {
                "emphasizedDomains": {
                  "items": {
                    "enum": [
                      "housing",
                      "zoning",
                      "taxes",
                      "permits",
                      "public_safety",
                      "transportation",
                      "environment",
                      "business",
                      "utilities",
                      "schools",
                      "other"
                    ],
                    "type": "string"
                  },
                  "type": "array"
                },
                "input": {
                  "type": "string"
                },
                "rationale": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "input",
                "emphasizedDomains",
                "rationale"
              ],
              "type": "object"
            },
            "followUp": {
              "additionalProperties": false,
              "properties": {
                "answer": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "caveats": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "citations": {
                  "items": {
                    "additionalProperties": false,
                    "properties": {
                      "fetchedAt": {
                        "type": "string"
                      },
                      "locator": {
                        "type": "string"
                      },
                      "recordId": {
                        "type": "string"
                      },
                      "sourceName": {
                        "type": "string"
                      },
                      "sourceUrl": {
                        "format": "uri",
                        "type": "string"
                      }
                    },
                    "required": [
                      "sourceName",
                      "sourceUrl",
                      "fetchedAt",
                      "recordId"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "gatedReason": {
                  "type": "string"
                },
                "gatedReasonCode": {
                  "type": "string"
                },
                "question": {
                  "type": "string"
                },
                "status": {
                  "enum": [
                    "answered",
                    "gated",
                    "unsupported"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "question",
                "status",
                "answer",
                "citations",
                "caveats"
              ],
              "type": "object"
            }
          },
          "type": "object"
        },
        "signals": {
          "items": {
            "additionalProperties": {},
            "properties": {
              "artifactId": {
                "type": "string"
              },
              "boundedClaim": {
                "type": "string"
              },
              "citations": {
                "items": {
                  "additionalProperties": false,
                  "properties": {
                    "fetchedAt": {
                      "type": "string"
                    },
                    "locator": {
                      "type": "string"
                    },
                    "recordId": {
                      "type": "string"
                    },
                    "sourceName": {
                      "type": "string"
                    },
                    "sourceUrl": {
                      "format": "uri",
                      "type": "string"
                    }
                  },
                  "required": [
                    "sourceName",
                    "sourceUrl",
                    "fetchedAt",
                    "recordId"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "confidence": {
                "enum": [
                  "low",
                  "medium",
                  "high"
                ],
                "type": "string"
              },
              "localityMatch": {
                "enum": [
                  "direct",
                  "jurisdictional",
                  "statewide",
                  "weak"
                ],
                "type": "string"
              },
              "operativeProvision": {
                "type": "string"
              },
              "rateChange": {
                "additionalProperties": {},
                "properties": {
                  "deltaValue": {
                    "type": "number"
                  },
                  "extractedFrom": {
                    "enum": [
                      "title",
                      "summary",
                      "text"
                    ],
                    "type": "string"
                  },
                  "fromValue": {
                    "type": "number"
                  },
                  "kind": {
                    "enum": [
                      "property_tax",
                      "fee",
                      "levy",
                      "bond"
                    ],
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "sourceExcerpt": {
                    "type": "string"
                  },
                  "toValue": {
                    "type": "number"
                  },
                  "unit": {
                    "enum": [
                      "cents_per_100",
                      "usd",
                      "percent"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "kind",
                  "label",
                  "unit",
                  "toValue",
                  "extractedFrom",
                  "sourceExcerpt"
                ],
                "type": "object"
              },
              "relevance": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "signalId": {
                "type": "string"
              },
              "whatItDoesNotProve": {
                "type": "string"
              },
              "whyRelevant": {
                "type": "string"
              }
            },
            "required": [
              "signalId",
              "artifactId",
              "localityMatch",
              "relevance",
              "boundedClaim",
              "whyRelevant",
              "whatItDoesNotProve",
              "confidence",
              "citations"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "kind",
        "id",
        "generatedAt",
        "place",
        "intent",
        "policyRulesetVersion",
        "artifacts",
        "signals",
        "citations",
        "caveats"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "candidateSources": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "artifactTypes": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "level": {
                "enum": [
                  "state",
                  "county",
                  "city"
                ],
                "type": "string"
              },
              "sourceName": {
                "type": "string"
              },
              "sourceUrl": {
                "format": "uri",
                "type": "string"
              }
            },
            "required": [
              "level",
              "sourceName",
              "sourceUrl",
              "artifactTypes"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "caveats": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "charged": {
          "const": false,
          "type": "boolean"
        },
        "intent": {
          "type": "string"
        },
        "kind": {
          "const": "policy_coverage_diagnostic",
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "place": {
          "additionalProperties": false,
          "properties": {
            "coverageStatus": {
              "enum": [
                "unsupported",
                "no_policy_artifacts",
                "no_relevant_policy"
              ],
              "type": "string"
            },
            "input": {
              "type": "string"
            },
            "jurisdictionIds": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "resolved": {
              "type": "string"
            }
          },
          "required": [
            "input",
            "coverageStatus"
          ],
          "type": "object"
        },
        "requestCoverage": {
          "additionalProperties": false,
          "properties": {
            "endpoint": {
              "type": "string"
            },
            "note": {
              "type": "string"
            },
            "tool": {
              "type": "string"
            }
          },
          "required": [
            "tool",
            "endpoint",
            "note"
          ],
          "type": "object"
        },
        "whatWeWouldNeed": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "kind",
        "place",
        "intent",
        "charged",
        "message",
        "candidateSources",
        "whatWeWouldNeed",
        "caveats"
      ],
      "type": "object"
    }
  ]
}