Recommend

post https://api.us-east-1.relevance.ai/latest/datasets/{dataset_id}/recommend

Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using the documentsToRecommend property.

Response

Response body

object

results

array of objects

required

List of documents. List items are affected by page, pageSize, query, filters. Items order is affected by vectorSeachQuery, sort, textSort.

Example: [{"_id":"abcd","animal":"cat","price":10}, {"_id":"abcd","price":13}]

results*

object

_relevance

number

Measures how closely a document matches on query and vectorSearchQuery.

_chunk_results

object

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.us-east-1.relevance.ai/latest/datasets/dataset_id/recommend \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation