API Technical Specs

SovScore

SovScore is the overall score that represents the bidirectional fit between the source and target documents. This score is calculated from the Weighted Score and Reverse Compatibility Score using a proprietary algorithm. This considers both directions of the match.

Weighted Score

An integer score from 0-100 representing how well the target document matched the source document. This calculation is the sum of the unweighted category scores multiplied by their respective suggested weight.

Reverse Compatibility Score (RCS)

An integer score from 0-100 which represents how well the source document matched to the target document. This isn't the same as WeightedScore because when doing the reverse calculation, we are analyzing for all of the data from the target document to be found in the source document. For example, a position for a software developer that needs C#, Web Api, and SQL Server would have a high weighted score when matched to a full-stack engineer that knows C#, Web API, SQL Server, Html, CSS, JavaScript, typescript, and many other skills; however, the RCS score would be much lower, because from the candidates perspective, this job only requires a very small subset of the breadth of skills the candidate has.

Categories

Location Filtering

Our engine allows you to filter searches and matches based on an exact location, or a radius from that location. For example, we can filter to an exact match to Dallas, Texas, or say 25 miles from Dallas, Texas. When using a distance, our API will call out to Google to get the geo coordinates of the address you specify. Just like the Geocode endpoint, you can specify your account Google or Bing account, or you can pass the latitude and longitude directly into the search or match call. Geocoding in a search or match follows the same cost structure as the Geocode endpoint and is documented here.

Filter an exact address

{  
    "FilterCriteria": {
        "LocationCriteria": {
        "Locations": [
            {
            "CountryCode": "US",
            "Region": "Texas",
            "Municipality": "Dallas"
            }
        ]
        }
    }
}

Filter 25 miles from an exact address using the built in Google account

{  
    "FilterCriteria": {
        "LocationCriteria": {
        "Locations": [
            {
            "CountryCode": "US",
            "Region": "Texas",
            "Municipality": "Dallas"
            }
        ],
        "Distance": 25,
        "DistanceUnit": "Miles"
        }
    }
}

Filter 25 miles from an exact address using predefined latitude and longitude

{  
    "FilterCriteria": {
        "LocationCriteria": {
        "Locations": [
            {
            "GeoPoint": {
                "Latitude": 32.780115,
                "Longitude": -96.7851757
            },
            }
        ],
        "Distance": 25,
        "DistanceUnit": "Miles"
        }
    }
}

Boolean Syntax

A Boolean search request consists of a group of words or phrases linked by connectors such as AND, OR, NOT that indicate the relationship between them.

If you use more than one connector, you should use parentheses to indicate precisely what you want to search for. For example, apple AND pear OR orange could mean (apple AND pear) or orange, or it could mean apple AND (pear OR orange).

Special Operators

Search terms may include the following special characters:

Semantic Expressions

Search expressions support Semantic Clauses, which are Sovren extensions to the underlying search engine syntax that can be placed anywhere within the Boolean expression. Semantic Clauses take the following form: type:(term; parameter1=value; parameter2=value; ...)

Each parameter is separated by semicolons. If a term or parameter value contains an equal sign, semicolon or parentheses, then it must be surrounded by double-quotes or those characters must be escaped by a backslash character. When inside double-quotes, only double-quote characters must be escaped by a backslash. If the values come from user input, then make sure that you escape those values to prevent search syntax errors or unexpected results.

The following semantic clauses are supported: