Recommendations

Recommendations are customisable algorithms that Adaptemy configures based on the Learning Design phase of an implementation project.

The Recommendation object

The Recommendation object takes a standard format, though the computation behind the recommendation can be configured for each organisation / course, and by specifying various parameters of the recommendations call.

Recommendations are per learner or per classgroup.

The recommendations are dependent on:

• the learner model (see learner-profile)

• the curriculum model

• the content model

• the context, as passed as input to the recommendation call

• any query parameters passed to the recommendation call

The response returns a ranked list of recommendations. Each recommendation object has the following properties:

Property	Description
Rank	Rank of recommendation. Rank = 1 is the highest priority recommendation
Course	The course.id of the recommendation. If the course is passed as a context, this property is assumed and omitted.
Module	The module.id of the recommendation. If the module is passed as a context, this property is assumed and omitted.
Concept	The concept.id of the recommendation.
Content.id	id of the recommended content-object
Content.type	type of content-object recommended
Extensions	Any further parameters of the recommendation

Sample Recommendations

Module

[
    {
        "recommendationId": "2f7633a1-676a-42a3-9770-673392edf854",
        "user": {
            "homepage": "https://buildup.ie",
            "name": "3234adb6-a90b-4ae2-9ea3-28f5577848d9"
        },
        "context": {
            "course": "e2bba794-16e0-3f1f-3993-77460b32b66e",
            "module": "https://buildup.ie/module?topic=e2bba794-16e0-3f1f-3993-77460b32b66e",
            "strategy": "bestCoverage"
        },
        "recommendations": [
            {
                "rank": 1,
                "course": "e2bba794-16e0-3f1f-3993-77460b32b66e",
                "module": "https://buildup.ie/module?topic=e2bba794-16e0-3f1f-3993-77460b32b66e",
                "concept": "611e2c3f-a7cc-d22e-f35a-4a71f1949c54",
                "content": {
                    "id": "https://buildup.ie/content/3abdfe6d-e85f-40c0-bbf2-281c0b1cb630",
                    "type": "http://adlnet.gov/expapi/activities/media"
                },
                "extensions": {}
            },
            {
                "rank": 2 // another recommedation object
            }
        ]
    }
]

Concept

recommendations

GET https://api.adaptemy.io/recommendations

The recommendations endpoint typically returns a list of concepts or content objects for the learner, given a set of context parameters and based on the user's latest learnerprofile. To receive documentation on the configuration for your organisation, please contact your Account Manager.

Query Parameters

Name	Type	Description
account	string	account (homepage/name) of the user
course	string	course.id to limit recommendations to one course
module	string	module.id to limit recommendations within one module
concept	string	concept.guid to limit recommendations within one concept
content-object	string	content-object.id to limit recommendations within one content-object e.g. question-level
registration	string	registration.id of content-object delivery to resume
strategy	string	preferred recommendation strategy, from agreed list

200

[
    {
        "recommendationId": "2f7633a1-676a-42a3-9770-673392edf854",
        "user": {
            "homepage": "https://buildup.ie",
            "name": "3234adb6-a90b-4ae2-9ea3-28f5577848d9"
        },
        "context": {
            "course": "e2bba794-16e0-3f1f-3993-77460b32b66e",
            "module": "https://buildup.ie/module?topic=e2bba794-16e0-3f1f-3993-77460b32b66e",
            "concept": "611e2c3f-a7cc-d22e-f35a-4a71f1949c54",
            "strategy": "bestCoverage"
        },
        "recommendations": [
            {
                "rank": 1,
                "course": "e2bba794-16e0-3f1f-3993-77460b32b66e",
                "module": "https://buildup.ie/module?topic=e2bba794-16e0-3f1f-3993-77460b32b66e",
                "concept": "611e2c3f-a7cc-d22e-f35a-4a71f1949c54",
                "content": {
                    "id": "https://buildup.ie/content/3abdfe6d-e85f-40c0-bbf2-281c0b1cb630",
                    "type": "http://adlnet.gov/expapi/activities/media"
                },
                "extensions": {}
            },
            {
                "rank": 2 // another recommedation object
            }
        ]
    }
]