Skip to main content

Get Recommendations

Parameters

Name

In

Type

Required

Description

configId

path

integer(int32)

true

The ID of the configuration to use for recommending documents.

uri

query

string

true

The URI of the document to get recommended documents for.

recommender

query

string

true

The recommender plugin to use for recommending documents.

Example cURL Request
curl 'https://adf-dev.semantic-web.at/ADF/api/configurations/getRecommendations?uri=https%3A%2F%2Fsustainabilityreport.metlife.com%2Fcontent%2Fdam%2Fmetlifecom%2Fus%2Fsustainability%2Fsus-refresh-2022%2Freport-website%2Fpdf%2F2021-sustainability-report.pdf&recommender=Risk%20recommender' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ3U2ZNbmY1Wm9leEFhc2NiSnNtZ2tlNktHRnc2NG1laWY0MzJwNHBXX2RrIn0.eyJleHAiOjE3MDk3MzQ3NjUsImlhdCI6MTcwOTczNDQ2NSwianRpIjoiZjU3ODhkODctZTFlMy00ZWU0LThkYWUtMTI5YmRmNjM2MTg2IiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1pbnRlcm5hbC1ldS5wb29scGFydHkuYml6L2F1dGgvcmVhbG1zL3ZvY2FidWxhcnkuc2VtYW50aWMtd2ViLmF0IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQwNjk1MTk2LTQyZGYtNGIzOS05NGEyLTQ1MzgzOGM3YzEzMSIsInR5cCI6IkJlYXJlciIsImF6cCI6InBwdCIsInNlc3Npb25fc3RhdGUiOiIzODA1M2YzYS1lZTA5LTRhOGEtYjdkNi0zZDI2MzI2NjY0YWEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJQb29sUGFydHlTdXBlckFkbWluIiwibG9jYWwtdXNlciIsInVtYV9hdXRob3JpemF0aW9uIiwiZGVmYXVsdC1yb2xlcy12b2NhYnVsYXJ5LnNlbWFudGljLXdlYi5hdCJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIGVtYWlsIHByb2ZpbGUiLCJzaWQiOiIzODA1M2YzYS1lZTA5LTRhOGEtYjdkNi0zZDI2MzI2NjY0YWEiLCJpcmkiOiJodHRwOi8vcmVzb3VyY2Uuc2VtYW50aWMtd2ViLmF0L3VzZXIvbGFrb21jaWtvdmFyIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsInVpTGFuZ3VhZ2UiOiJlbiIsImRpc3BsYXlMYW5ndWFnZXMiOlsiIl0sInNrb3NWaWV3IjoiQkFTSUNTS09TVklFVyIsIm5hbWUiOiJSb21hbmEgTGFrb21jaWtvdmEiLCJncm91cHMiOlsiL0NvY2t0YWlscyIsIi9QdWJsaWMiLCIvU1dDIl0sInRpbWVab25lIjoiRXVyb3BlL1ZpZW5uYSIsInByZWZlcnJlZF91c2VybmFtZSI6Imxha29tY2lrb3ZhciIsImdpdmVuX25hbWUiOiJSb21hbmEiLCJhY0xhbmd1YWdlIjoiZW4iLCJmYW1pbHlfbmFtZSI6Ikxha29tY2lrb3ZhIn0.TrC_p_ZDizOt7UWjV69-wiCU2A3q1QnG6Yp1SMNZMzgt0ss4gOr8uO51xWQPFu0YMJg9_GV4gGm8vY-_7Hf7_XADgSZhyJJ7CwZLCfgqKYxlApRTOA9tN3os5lB7wpZBBxoBHmZLqitq2McngA6v7lPviJBZisrQKWbbmAC-hmrbd53PVJV7SKX4TG2do6GM1UsSNk3JjP9w5sNJTLOQmS6Ox6A6ANYSxB0H9NegHvDVV2vSU-sRfvTh7IgGBs0-BJJO0AM-QNigt_gNNzVgUx8WP-SqRbDEdDqQoV81OVQxwlZw6cZ98f6vjJKVmwiZh610aIrJ1NJiewT1YQCt6Q'

Responses

Status

Meaning

Description

200

OK 

List of recommended 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

A message informing on the success of the operation.

total

integer(int32)

false

The total number of retrieved documents.