Scores

Owned by Patrice Neff
Last updated: Nov 25, 2015
2 min read

The scores resource does batch-calculations of fingerprints relevance for each item in a project.This resource is used by the  Bulk Scorer utility.

Methods

Calculate Scores

GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/scores

Returns an array of all objects in the project.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
Query Parameters:
  • tags (mandatory) – Comma-separated list of tags for which the fingerprints should be used in calculation.
  • object_id (optional) – Limit the calculations to all items in this object.
  • fields (optional) – Comma-separated list of fields to return in the response. Defaults to external_id.
Headers:See Common Headers.
Status Codes:
  • 200 – Array of objects dictionaries is returned.

See also Common Status Codes.

Returns:

Array of fingerprints with a score entry for each item.

Every item returns the selected fields and the noise level for which the item matches that fingerprint.

[
    {
        "scores": [
            {
                "fields": {"external_id": "a38515"},
                "noise_level": 0.0
            },
            {
                "fields": {"external_id": "a37402"},
                "noise_level": 0.0
            },
            {
                "fields": {"external_id": "a38116"},
                "noise_level": 0.1
            }
        ],
        "fingerprint": {
            "filter_min_score": null,
            "type_id": "squirro",
            "type": "tenant",
            "name": "ma",
            "title": ""
        }
    }
]