Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs-attestly.code4source.com/llms.txt

Use this file to discover all available pages before exploring further.

Um ruleset é um documento JSON que descreve:
  1. Quais sources consultar (e como filtrá-los).
  2. Quais valores computar (counts, áreas, distâncias).
  3. Quais condições devem valer para o resultado ser compliant.
Envie o ruleset inline a cada /v1/evaluate, ou salve uma vez no catálogo e referencie por name@version depois.

​
Anatomia

{
  "name": "br-rural-credit",
  "version": 1,
  "description": "Elegibilidade de crédito rural por Resolução BCB 4.943",

  "sets": {
    "indigenous_overlap": {
      "source": "br:funai:indigenous-territories",
      "join": { "op": "intersects", "target": "$input" }
    },
    "embargo_overlap": {
      "source": "br:ibama:embargoed-areas",
      "join": { "op": "intersects", "target": "$input" }
    }
  },

  "projections": {
    "indigenous_area": {
      "set": "$indigenous_overlap",
      "terminal": { "type": "total_area_m2" }
    }
  },

  "checks": [
    {
      "id": "no_indigenous_overlap",
      "severity": "critical",
      "predicate": { "type": "exists", "set": "$indigenous_overlap" }
    },
    {
      "id": "no_embargo_overlap",
      "severity": "high",
      "predicate": { "type": "exists", "set": "$embargo_overlap" }
    }
  ]
}

​
Os três blocos

​
sets — quais feições considerar

Um set é ancorado em um source e cruzado contra $input (sua geometria/identificador da request) ou outro set. Operadores de join disponíveis:
  • intersects — sobreposição de geometria
  • contains / within — contenção total
  • dwithin — dentro de um buffer
  • disjoint — sem sobreposição
  • subject_match — match por identificador (para subject registers)
Você também pode construir sets via operações de conjunto: 
{
  "any_protected": {
    "from_set_op": {
      "op": "union",
      "operands": ["$indigenous_overlap", "$conservation_overlap"]
    }
  }
}

​
projections — o que computar

Projections produzem valores numéricos ou geométricos. Terminais comuns:
  • count — número de feições casadas
  • total_area_m2, total_perimeter_m
  • overlap_ratio — fração do input coberta
  • min_distance_m, max_distance_m
  • aggregate — sum / avg / min / max de uma propriedade da feição
  • merge — geometria unificada (para visualização)
Projections não disparam o verdict — só produzem valores.

​
checks — o que precisa valer

Checks têm uma severity e um predicate: 
{
  "id": "max_3_overlaps",
  "severity": "medium",
  "predicate": {
    "type": "threshold",
    "projection": "total_overlap_count",
    "op": "<=",
    "value": 3
  }
}
Severities, da mais forte para a mais fraca: critical, high, medium, low, info. Veja Verdicts para entender como mapeiam para outcomes.

​
Atalho inline

Caso comum — count + threshold em um único check. O parser aceita: 
{
  "id": "at_least_one_car",
  "severity": "high",
  "predicate": {
    "type": "count",
    "set": "$car_overlap",
    "op": ">=",
    "value": 1
  }
}
A projection do threshold fica implícita pelo predicate.

​
Filtros

Restrinja um set com filter: 
{
  "recent_embargoes": {
    "source": "br:ibama:embargoed-areas",
    "join": { "op": "intersects", "target": "$input" },
    "filter": {
      "type": "temporal_relative",
      "property": "embargo_date",
      "op": "within_days",
      "value": 365
    }
  }
}

​
Política de verdict customizada

Sobrescreva o mapeamento default de severity com uma política explícita: 
{
  "verdict_policy": {
    "kind": "severity_mapping",
    "rules": {
      "critical": "non_compliant",
      "high":     "non_compliant",
      "medium":   "warning",
      "low":      "warning",
      "info":     "compliant"
    }
  }
}

​
Limites

Para manter respostas previsíveis, a API impõe:
LimiteDefault
Máximo de sets20
Máximo de checks50
Máximo de projections20
Profundidade máxima5
Distância máxima de buffer50 km
Área máxima do input1 000 km²
Máximo de evidence por check20
Exceder qualquer um retorna 422 PROGRAM_VALIDATION_ERROR.

​
A seguir

  • Exemplos — rulesets completos para políticas comuns.
  • Catálogo — salve e versione seu ruleset.