API Reference

Enhance

get
https://kg.diffbot.com/kg/v3/enhance

Enrich a person or organization record with partial data input

Enhance is an enrichment API to find a person or organization using partial data as input. Enhance scores several candidates against the submitted query and returns the best match. More information in the query helps Enhance models estimate with more confidence and will typically result in better matches and a higher score for the matches.

GET /kg/v3/enhance?type={type}&name={name}&location={address}.

Where {type} is either Person or Organization, {name} is the name of the entity and {address} is a complete or partial address of the entity

You can specify more/other input, such as url or employer. The supported parameters are listed below.

Scoring and Threshold

Enhance uses a cut-off based on the F2 score by default, erring on the side of recall. However, you can control the threshold using the threshold parameter depending on your application's specific needs.

Enhance also returns at most 1 result by default. You can control this with the size parameter. Note that this can cause proportionately more credits to be used if there are more matches returned.

(size parameter is not supported for combine requests)

Refresh mode

It is possible that some of the origins for the results have not been revisited by our crawler in a while. If you need fresher data than what's available, you can force a refresh with the refresh=true parameter. Any origins that have not been crawled in the last 30 days will be recrawled and merged with the entity found in the Knowledge Graph.

🚧

The refresh parameter should not be used by default. Refreshing origins in general and refreshing all origins in particular can be a time-consuming request as Enhance needs to recrawl pages before merging them into the result. If you need only specific origins refreshed, you can also control that using the refreshOrigins parameter.

Search mode

By default, Enhance returns entities in the Knowledge Graph. It can also search the web for the queried entity with the search=true parameter. Search results are scored for a match and merged with the entity found in the Knowledge Graph.

🚧

The search parameter should not be used by default. It can be very slow and the quality of results are usually variable external websites. In our experience, this parameter is not usually necessary.

Query Params
string
enum

Diffbot entity type

Allowed:
string

DiffbotId of entity to enhance. Parameter can be used with types Person and Organization

name
array of strings

Name of the entity to enhance. Parameter can be used with types Person and Organization

name
url
array of strings

Origin or homepage URI of entity to enhance. Parameter can be used with types Person and Organization

url
string

Phone of the entity to enhance. Parameter can be used with types Person and Organization

email
array of strings

Email of the entity to enhance. Parameter can be used only with type Person

email
string

Employer of the entity to enhance. Parameter can be used only with type Person

string

Title of the entity to enhance. Parameter can be used only with type Person

string

School of the entity to enhance. Parameter can be used only with type Person

string

Location of the entity to enhance. Parameter can be used with types Person and Organization

string

Description of the entity to enhance. Parameter can be used with types Person and Organization

string

IP address of the entity to enhance. Parameter can be used with types Person and Organization

string

User defined ID for correlation

int32
Defaults to 1

Maximum number of results to return

double

Enhance similarity threshold

boolean
Defaults to false

refresh=true indicates that Diffbot will attempt to recrawl all the origins of the identified entity and reconstruct the returned entity from this refreshed data.

boolean
Defaults to false

search=true indicates that Diffbot will attempt to search the web for origins for the search query and merge relevant results with whats found in the KG.

boolean
Defaults to false

nonCanonicalFacts=true returns non-canonical facts.

string
enum
Defaults to

jsonmode=extended returns origin information for facts.

Allowed:
string

Semi-colon separated path filter to filter response json. You can use a simple dot notation skills.name or a JsonPath expression such as such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

string

Semi-colon separated path filter to filter and exclude data from response json. You can use a simple dot notation skills.name or a JsonPath expression such as such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

Responses

Updated 8 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago