Skip to content

Get Data Quality Scores Tool

This tool looks up the data quality score for a set of catalog objects you already have references to. It is the lightweight companion to the Get Data Quality Tool: rather than running checks, it returns the scores Alation already holds.

Use it right after a catalog search, when the user asks about the trustworthiness or reliability of specific objects that turned up in results. The agent reads the object type and ID from each search result and passes them in.

ParameterRequiredTypeSuggested scopeWhat it does
objectsYeslist of objectsAgent determinedThe objects to score. Each entry has an object_type (e.g. "table", "report_object") and an object_id.

See Configuring tool parameters for what the scope column means.

{
"objects": [
{ "object_type": "table", "object_id": "123" },
{ "object_type": "table", "object_id": "456" }
]
}

A list of the requested objects with their data quality scores. A score is null when none is available for that object.