curl --request POST \
--url https://api.trieve.ai/api/analytics/recommendations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"filter": {
"component_name": "<string>",
"date_range": {
"gt": "2021-01-01 00:00:00.000",
"gte": "2021-01-01 00:00:00.000",
"lt": "2021-01-01 00:00:00.000",
"lte": "2021-01-01 00:00:00.000"
},
"recommendation_type": "Chunk",
"top_score": {
"gt": 123,
"gte": 123,
"lt": 123,
"lte": 123
}
},
"page": 1,
"threshold": 123,
"type": "low_confidence_recommendations"
}'
{
"queries": [
{
"created_at": "<string>",
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<any>",
"negative_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"negative_tracking_ids": [
"<string>"
],
"positive_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"positive_tracking_ids": [
"<string>"
],
"recommendation_type": "Chunk",
"request_params": "<any>",
"results": [
"<any>"
],
"top_score": 123,
"user_id": "<string>"
}
]
}
This route allows you to view the recommendation analytics for a dataset.
curl --request POST \
--url https://api.trieve.ai/api/analytics/recommendations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"filter": {
"component_name": "<string>",
"date_range": {
"gt": "2021-01-01 00:00:00.000",
"gte": "2021-01-01 00:00:00.000",
"lt": "2021-01-01 00:00:00.000",
"lte": "2021-01-01 00:00:00.000"
},
"recommendation_type": "Chunk",
"top_score": {
"gt": 123,
"gte": 123,
"lt": 123,
"lte": 123
}
},
"page": 1,
"threshold": 123,
"type": "low_confidence_recommendations"
}'
{
"queries": [
{
"created_at": "<string>",
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<any>",
"negative_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"negative_tracking_ids": [
"<string>"
],
"positive_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"positive_tracking_ids": [
"<string>"
],
"recommendation_type": "Chunk",
"request_params": "<any>",
"results": [
"<any>"
],
"top_score": 123,
"user_id": "<string>"
}
]
}
The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.
JSON request payload to filter the graph
The body is of type object
.
The recommendation analytics for the dataset
The response is of type object
.
Was this page helpful?