Skip to main content

Get Similar Documents

Parameters

Name

In

Type

Required

Description

configId

path

integer(int32)

true

The ID of the configuration to use for suggesting similar documents.

number

query

integer(int32)

false

The maximum number of suggested similar documents.

uri

query

string

true

The URI of the document to get similar documents for.

similarity

query

string

false

The similarity plugin to use. For more information on GraphSearch plugins, refer to the PoolParty documentation.

Example cURL Request
curl 'https://adf-dev.semantic-web.at/ADF/api/configurations/3/getSimilar?uri=https%3A%2F%2Fsustainabilityreport.metlife.com%2Fcontent%2Fdam%2Fmetlifecom%2Fus%2Fsustainability%2Fsus-refresh-2022%2Freport-website%2Fpdf%2F2021-sustainability-report.pdf%23page%3D16%26seq%3D1&similarity=Risk%20Similarity' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJfeXpPU1JLUkV5MWg2SFUyeDNYaG9EdXQyUEItRldZWmpVcTVqdF93UUpNIn0.eyJleHAiOjE3MDE5Njg1NTIsImlhdCI6MTcwMTk2ODI1MiwianRpIjoiMTgzNTQwOTktY2VjZi00NjFhLTk3ZWItMTEzMjdhMmI4OTNiIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1pbnRlcm5hbC1ldS5wb29scGFydHkuYml6L2F1dGgvcmVhbG1zL3JkZm94LWludGVncmF0aW9uLnBvb2xwYXJ0eS5iaXoiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiMmY4N2RiZjYtZWExZC00OTc5LWE3YWYtNmEwZTExMTA0N2IyIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicHB0Iiwic2Vzc2lvbl9zdGF0ZSI6IjgzNGI2YTAzLTBmNTYtNDcwMC1hNWYyLTk5MmJhYmE0ZGMyZiIsImFsbG93ZWQtb3JpZ2lucyI6WyIqIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImxvY2FsLXVzZXIiLCJQb29sUGFydHlVc2VyIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLXJkZm94LWludGVncmF0aW9uLnBvb2xwYXJ0eS5iaXoiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwic2lkIjoiODM0YjZhMDMtMGY1Ni00NzAwLWE1ZjItOTkyYmFiYTRkYzJmIiwiaXJpIjoiaHR0cHM6Ly9yZGZveC1pbnRlZ3JhdGlvbi5wb29scGFydHkuYml6L3VzZXIvMmY4N2RiZjYtZWExZC00OTc5LWE3YWYtNmEwZTExMTA0N2IyIiwidWlMYW5ndWFnZSI6ImVuIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJkaXNwbGF5TGFuZ3VhZ2VzIjpbIiJdLCJza29zVmlldyI6IkJBU0lDU0tPU1ZJRVciLCJuYW1lIjoiUFBJTCBUZXN0IFVzZXIiLCJncm91cHMiOlsiL3BwaWwiXSwidGltZVpvbmUiOiJFdXJvcGUvVmllbm5hIiwicHJlZmVycmVkX3VzZXJuYW1lIjoicHBpbCIsImdpdmVuX25hbWUiOiJQUElMIiwiYWNMYW5ndWFnZSI6ImVuIiwiZmFtaWx5X25hbWUiOiJUZXN0IFVzZXIifQ.n4Tj5jUGO2fa5j94GmENmyUG5AAlOk2M2G18YOok9yrTIUotx93bGrPJcWBXMN6lAoGg6e9-QUr_mogjb0rOmp4wnWsp_5Pom7xD_QJYQd0iCElanYO-OWKjJiLpvq27hA1o6ro2i-TGKTNUdlijzpWZNS0Q7wy65Eq3QcKrRC7tW4JYU3_idQpmyrQ48hz-uWZD6BcrrjGXy5-33cW-0HkxoCstzalFXTFQ5aNEEhAZw9IvDEDb3dAprz6bik9WdI7SAgfYCwNuUWN9zb3a6ojbhg4RIp1Eugss-Wgl728rz1jQK43ECD9O4wZ73un3_nA8ArFAyMTrMtc7W8QrgQ'

Responses

Status

Meaning

Description

200

OK

List of similar documents

401

Unauthorized

Unauthorized

403

Forbidden

Forbidden

404

Not Found

Not Found

200 Response Example
200 Response Schema

Name

Type

Required

Description

message

string

false

A message informing about the duration of the operation in milliseconds.

result

array

false

An array of objects, each representing a single retrieved document.

GSDocument

resultType

string

false

The MIME type identifier of the result.

status

integer(int32)

false

The HTTP status code of the operation.

success

boolean

false

The information whether the operation has been successful.

total

integer(int32)

false

The total number of retrieved documents.