Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/rescue-retriever/llms.txt

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

The Candidate Detail page gives you a complete picture of any individual animal — its shelter record, how it scored against each of the three rescue programs, and a plain-English explanation of exactly why each score came out the way it did. To open it, click the View button in any row of the Dashboard table.

​
Shelter Record

The top section of the detail page displays the animal’s neutral shelter data exactly as recorded in the Austin Animal Center dataset:
FieldDescription
animalIdUnique shelter identifier (e.g. A706953)
nameAnimal name as recorded at intake
breedShelter breed assessment
colorRecorded coat color
sexSex and reproductive status (e.g. Intact Female, Neutered Male)
ageAge rounded to the nearest whole week
locationShelter or service-area location string
No scoring or program logic is applied in this section — it reflects the raw intake record.

​
Program Scores

Below the shelter record, a score card is shown for each of the three rescue programs: Water, Mountain, and Disaster. Each card contains:
  • matchScore — a numeric score from 0 to 100 representing how well the animal fits that program’s criteria
  • breedMatch — boolean indicating whether the animal’s breed matches the program’s preferred breed list
  • sexMatch — boolean indicating whether the animal’s sex matches the program’s preferred sex
  • ageMatch — boolean indicating whether the animal’s age (in rounded weeks) falls within the program’s minimum and maximum age range
Scores are calculated as follows: a breed match contributes 50 points, a sex match contributes 25 points, and an age match contributes 25 points. Partial matches receive a baseline of 12 points (breed miss), 5 points (sex miss), or 5 points (age miss) respectively, keeping all scores within a 22–100 range.

​
Match Rationale

Each score card includes a rationale array: three human-readable strings, one per criterion, explaining the result in plain language. This makes it easy to understand at a glance exactly what is and isn’t working for a given animal–program combination. Example rationale for a Labrador Retriever Mix that is Intact Male, age 30 weeks, evaluated against the Water Rescue program: 
{
  "programId": "water",
  "matchScore": 80,
  "breedMatch": true,
  "sexMatch": false,
  "ageMatch": true,
  "qualifies": false,
  "rationale": [
    "Breed matches the Water profile.",
    "Sex differs from the preferred Intact Female criterion.",
    "Age is within the 26–156 week range."
  ]
}
In this example the animal scores 80 (breed match 50 + sex miss 5 + age match 25 = 80) — the rationale strings tell you immediately that the sex criterion is the only thing preventing full qualification. Possible rationale strings include:
  • "Breed matches the [Program] profile." / "Breed is outside the preferred [Program] list."
  • "Sex matches the preferred [sex] criterion." / "Sex differs from the preferred [sex] criterion."
  • "Age is within the [min]–[max] week range." / "Age is outside the [min]–[max] week range."

​
Shortlisting Candidates

The Candidate Detail page is a read-only view — there is no in-app shortlist or saved list feature. To build a working set of candidates, return to the Dashboard and use the program filter and search bar to isolate the animals you want, then use the Export CSV button to download that filtered list for use in external tools or intake tracking systems.
Age is always rounded to the nearest whole week before scoring and display. An animal with ageWeeks: 30.35 appears and scores as 30 weeks. This rounding is applied consistently across the Dashboard table, the detail page, and the CSV export.
  • Dashboard — filter and rank all candidates before opening detail views
  • Scoring Algorithm — full technical specification of how matchScore, breedMatch, sexMatch, and ageMatch are computed

Build docs developers (and LLMs) love

Get started for freeTalk to us