app.gainforest.evaluator.defs

gainforest.earth

Documentation

candidateTaxon object

A candidate taxon identification with confidence score and rank.

Properties

confidence integer Required

Confidence score (0-1000, where 1000 = 100.0%).

minimum: 0maximum: 1000
family string Optional

Family of the candidate taxon.

maxGraphemes: 128 graphemes
gbifTaxonKey string Optional

GBIF backbone taxonomy key for the candidate.

maxGraphemes: 64 graphemes
genus string Optional

Genus of the candidate taxon.

maxGraphemes: 128 graphemes
kingdom string Optional

Kingdom of the candidate taxon.

maxGraphemes: 128 graphemes
rank integer Required

Rank position among candidates (1 = best match).

minimum: 1
scientificName string Required

Full scientific name of the candidate taxon.

maxGraphemes: 512 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "scientificName",
    "confidence",
    "rank"
  ],
  "properties": {
    "rank": {
      "type": "integer",
      "minimum": 1,
      "description": "Rank position among candidates (1 = best match)."
    },
    "genus": {
      "type": "string",
      "description": "Genus of the candidate taxon.",
      "maxGraphemes": 128
    },
    "family": {
      "type": "string",
      "description": "Family of the candidate taxon.",
      "maxGraphemes": 128
    },
    "kingdom": {
      "type": "string",
      "description": "Kingdom of the candidate taxon.",
      "maxGraphemes": 128
    },
    "confidence": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 0,
      "description": "Confidence score (0-1000, where 1000 = 100.0%)."
    },
    "gbifTaxonKey": {
      "type": "string",
      "description": "GBIF backbone taxonomy key for the candidate.",
      "maxGraphemes": 64
    },
    "scientificName": {
      "type": "string",
      "description": "Full scientific name of the candidate taxon.",
      "maxGraphemes": 512
    }
  },
  "description": "A candidate taxon identification with confidence score and rank."
}
classificationResult object

Generic categorical classification result (e.g., conservation priority, habitat type).

Properties

category string Required

The classification category (e.g., 'conservation-priority', 'habitat-type').

maxGraphemes: 128 graphemes
remarks string Optional

Additional notes about the classification.

maxGraphemes: 2048 graphemes
value string Required

The assigned classification value (e.g., 'critical', 'tropical-rainforest').

maxGraphemes: 256 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "category",
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "description": "The assigned classification value (e.g., 'critical', 'tropical-rainforest').",
      "maxGraphemes": 256
    },
    "remarks": {
      "type": "string",
      "description": "Additional notes about the classification.",
      "maxGraphemes": 2048
    },
    "category": {
      "type": "string",
      "description": "The classification category (e.g., 'conservation-priority', 'habitat-type').",
      "maxGraphemes": 128
    }
  },
  "description": "Generic categorical classification result (e.g., conservation priority, habitat type)."
}
dataQualityResult object

Data quality assessment result with per-field quality flags.

Properties

completenessScore integer Optional

Overall completeness score (0-1000, where 1000 = 100.0%).

minimum: 0maximum: 1000
flags array of ref#qualityFlag Required

List of quality issues found in the record.

maxLength: 50 items
remarks string Optional

Additional notes about the quality assessment.

maxGraphemes: 2048 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "flags"
  ],
  "properties": {
    "flags": {
      "type": "array",
      "items": {
        "ref": "#qualityFlag",
        "type": "ref"
      },
      "maxLength": 50,
      "description": "List of quality issues found in the record."
    },
    "remarks": {
      "type": "string",
      "description": "Additional notes about the quality assessment.",
      "maxGraphemes": 2048
    },
    "completenessScore": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 0,
      "description": "Overall completeness score (0-1000, where 1000 = 100.0%)."
    }
  },
  "description": "Data quality assessment result with per-field quality flags."
}
derivedMeasurement object

A single measurement derived by an evaluator from source data.

Properties

measurementMethod string Optional

Description of the method used to obtain the measurement.

maxGraphemes: 1024 graphemes
measurementType string Required

The nature of the measurement (e.g., 'canopy cover', 'NDVI', 'tree height').

maxGraphemes: 256 graphemes
measurementUnit string Optional

The units for the measurement value (e.g., '%', 'm', 'kg').

maxGraphemes: 64 graphemes
measurementValue string Required

The value of the measurement.

maxGraphemes: 1024 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "measurementType",
    "measurementValue"
  ],
  "properties": {
    "measurementType": {
      "type": "string",
      "description": "The nature of the measurement (e.g., 'canopy cover', 'NDVI', 'tree height').",
      "maxGraphemes": 256
    },
    "measurementUnit": {
      "type": "string",
      "description": "The units for the measurement value (e.g., '%', 'm', 'kg').",
      "maxGraphemes": 64
    },
    "measurementValue": {
      "type": "string",
      "description": "The value of the measurement.",
      "maxGraphemes": 1024
    },
    "measurementMethod": {
      "type": "string",
      "description": "Description of the method used to obtain the measurement.",
      "maxGraphemes": 1024
    }
  },
  "description": "A single measurement derived by an evaluator from source data."
}
measurementResult object

Derived measurements produced by an evaluator from source data (e.g., remote sensing metrics).

Properties

measurements array of ref#derivedMeasurement Required

List of derived measurements.

maxLength: 20 items
remarks string Optional

Additional notes about the measurements.

maxGraphemes: 2048 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "measurements"
  ],
  "properties": {
    "remarks": {
      "type": "string",
      "description": "Additional notes about the measurements.",
      "maxGraphemes": 2048
    },
    "measurements": {
      "type": "array",
      "items": {
        "ref": "#derivedMeasurement",
        "type": "ref"
      },
      "maxLength": 20,
      "description": "List of derived measurements."
    }
  },
  "description": "Derived measurements produced by an evaluator from source data (e.g., remote sensing metrics)."
}
methodInfo object

Provenance metadata describing the method used to produce an evaluation.

Properties

modelCheckpoint string Optional

Identifier for the specific model checkpoint used (e.g., date or hash).

maxGraphemes: 128 graphemes
name string Required

Human-readable name of the method or model (e.g., 'GainForest BioClassifier').

maxGraphemes: 256 graphemes
references array of stringuri Optional

URIs to papers, documentation, or repositories describing this method.

maxLength: 10 items
version string Optional

Version string of the method or model (e.g., '2.1.0').

maxGraphemes: 64 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name of the method or model (e.g., 'GainForest BioClassifier').",
      "maxGraphemes": 256
    },
    "version": {
      "type": "string",
      "description": "Version string of the method or model (e.g., '2.1.0').",
      "maxGraphemes": 64
    },
    "references": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "maxLength": 10,
      "description": "URIs to papers, documentation, or repositories describing this method."
    },
    "modelCheckpoint": {
      "type": "string",
      "description": "Identifier for the specific model checkpoint used (e.g., date or hash).",
      "maxGraphemes": 128
    }
  },
  "description": "Provenance metadata describing the method used to produce an evaluation."
}
qualityFlag object

A single data quality flag indicating an issue with a specific field.

Properties

field string Required

The field name that has the quality issue.

maxGraphemes: 64 graphemes
issue string Required

Description of the quality issue.

maxGraphemes: 256 graphemes
severity string Optional

Severity level of the quality issue.

maxGraphemes: 64 graphemes
Known values: error, warning, info
View raw schema
{
  "type": "object",
  "required": [
    "field",
    "issue"
  ],
  "properties": {
    "field": {
      "type": "string",
      "description": "The field name that has the quality issue.",
      "maxGraphemes": 64
    },
    "issue": {
      "type": "string",
      "description": "Description of the quality issue.",
      "maxGraphemes": 256
    },
    "severity": {
      "type": "string",
      "description": "Severity level of the quality issue.",
      "knownValues": [
        "error",
        "warning",
        "info"
      ],
      "maxGraphemes": 64
    }
  },
  "description": "A single data quality flag indicating an issue with a specific field."
}
speciesIdResult object

AI or human species recognition result with ranked candidate identifications.

Properties

candidates array of ref#candidateTaxon Required

Ranked list of candidate species identifications.

maxLength: 20 items
inputFeature string Optional

Which feature of the subject record was used as input (e.g., 'mediaEvidence').

maxGraphemes: 64 graphemes
remarks string Optional

Additional notes about the species identification.

maxGraphemes: 2048 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "candidates"
  ],
  "properties": {
    "remarks": {
      "type": "string",
      "description": "Additional notes about the species identification.",
      "maxGraphemes": 2048
    },
    "candidates": {
      "type": "array",
      "items": {
        "ref": "#candidateTaxon",
        "type": "ref"
      },
      "maxLength": 20,
      "description": "Ranked list of candidate species identifications."
    },
    "inputFeature": {
      "type": "string",
      "description": "Which feature of the subject record was used as input (e.g., 'mediaEvidence').",
      "maxGraphemes": 64
    }
  },
  "description": "AI or human species recognition result with ranked candidate identifications."
}
subjectRef object

Reference to a target record that is being evaluated.

Properties

cid string cid Optional

CID pinning the exact version of the target record.

uri string at-uri Required

AT-URI of the target record.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID pinning the exact version of the target record."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the target record."
    }
  },
  "description": "Reference to a target record that is being evaluated."
}
verificationResult object

Expert verification result for a previous identification or evaluation.

Properties

remarks string Optional

Notes about the verification decision.

maxGraphemes: 2048 graphemes
status string Required

Verification status: confirmed, rejected, or uncertain.

maxGraphemes: 64 graphemes
Known values: confirmed, rejected, uncertain
suggestedCorrections string Optional

Suggested corrections if the original identification was rejected or uncertain.

maxGraphemes: 5000 graphemes
verifiedBy string Optional

Name of the person who performed the verification.

maxGraphemes: 256 graphemes
verifiedByID string Optional

Persistent identifier (e.g., ORCID) of the verifier.

maxGraphemes: 256 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Verification status: confirmed, rejected, or uncertain.",
      "knownValues": [
        "confirmed",
        "rejected",
        "uncertain"
      ],
      "maxGraphemes": 64
    },
    "remarks": {
      "type": "string",
      "description": "Notes about the verification decision.",
      "maxGraphemes": 2048
    },
    "verifiedBy": {
      "type": "string",
      "description": "Name of the person who performed the verification.",
      "maxGraphemes": 256
    },
    "verifiedByID": {
      "type": "string",
      "description": "Persistent identifier (e.g., ORCID) of the verifier.",
      "maxGraphemes": 256
    },
    "suggestedCorrections": {
      "type": "string",
      "description": "Suggested corrections if the original identification was rejected or uncertain.",
      "maxGraphemes": 5000
    }
  },
  "description": "Expert verification result for a previous identification or evaluation."
}

Lexicon Garden

@