Version: Next

Changelog

All the newest features, improvements, bug fixes are shared here.

v2.4.3 (21/10/2021)

New Features / Improvements:

  • Add parameter 'reco_after_kn_positioned' in POST /recommendation_utils/fetch_content_recommendations to be able to fetch recommendations when Student is already positioned on a specific KnowledgeNode of the Objective without having to wait to be positioned on the whole Objective.
  • Improve GET requests on Domoscio Objects rendering speed when fetching large number of Objects.
  • Add option parameter 'start_session_at' for memorize and adaptive Objectives to define Session start date. This option can be defined when creating Objective or ObjectiveStudent.

v2.4.0 (22/08/2021)

New Features / Improvements:

  • Update of the LearningSession system, they are now automatically created on all workflow (positioning, adaptive & memorize) but it is still possible to create custom LS
  • New route to retrieve all stats related to LearningSessions, more about this here
  • New Attempts workflow available on the CogEngine, defined on the ObjectiveStudent with the attributes attempt_options, more info here
  • The routes
    • /recommendation_utils/initialize_attempts & /recommendation_utils/new_attempt are now deprecated
    • Replaced by /recommendation_utils/new_positioning_attempt, documentation available here
  • Adaptive & Memorize attributes are now declared within the Objective & ObjectiveStudent
  • New attribute start_review_at on the ObjectiveStudent to launch reviews on a specific date, more info here
  • New is_test_student parameter to declare test students, more about this here
  • Update on gameplay_utils to exclude test students
  • New param recommend_seen_content on /gameplay_utils/fetch_content_recommendations to recommend previously seen contents

Bug Fixes:

  • Fix initialization of memorization Objectives when Student is studying or already studied KnowledgeNodes from this Objective
  • Fix initialization of adaptive Objectives
  • Fix creation of OKNS with batch creation of OS
  • Remove N+1 requests on view KNC/Content
  • Fix error message When no RefreshToken in input

v2.3.1 (21/04/2021)

New Features / Improvements:

  • Improve score from /user_model_utils/ai_training_status by incorporating decay with time

Bug Fixes:

  • Prevent Recommendations before positioning when there is a positioning objective
  • Fix POST /objective_students/batch_create

v2.3.0 (12/04/2021)

New Features / Improvements:

  • Add new route POST /recommendation_utils/fetch_content_recommendations with the new Content RecommendationSystem
    • route GET /recommendation_utils/fetch_best_learning_recommendations is now deprecated (use new route with "recommendation_type" to "Learning")
    • route GET /recommendation_utils/fetch_best_content_recommendations is now deprecated (use new route with "recommendation_type" to "Evaluation")
  • Improve Event processing speed

v2.2.2 (04/03/2021)

New Features / Improvements:

  • Add route DELETE /objective_students to unsubscribe Students from Objectives
  • Add route PUT /objective_students to update in batch

Bug Fixes:

  • Filter duplicate contents in when fetching Recommendations
  • Fix initialization of thresholds in case parameter "knowledge_node_uids" is used
  • Fix deactivation of Reviews when updating OS active parameter

v2.2.0 (11/02/2021)

New Features / Improvements:

  • Add options to parameter positioning objectives with parameter "adaptive_options" when creating Objectives:
    • Use key "positioning" to choose if you want a positioning objective or not
    • Use key "positioning_type" to choose the type of positioning
  • Add routes for creating attempts (positioning retries) with:
  • Add route /contents/archive to archive contents. Archived contents won't be used in adaptive and memorize Objectives. However, statistics on the content will be kept and can be fetched in the STATS & DATA routes

Bug Fixes:

  • Fix positioning for KnowledgeNodes in multiple Objectives
  • Fix positioning parameters when update of Content difficulties

v2.1.9 (25/01/2021)

New Features / Improvements:

  • Add attribute "content_id" for group_by possibilites in /gameplay_utils/event_stats
  • Add route /events/batch_create for creating events in batch (faster when you want to create multiple events)

v2.1.8 (19/01/2021)

New Features / Improvements:

  • Improve speed of routes /gameplay_utils/event_stats and /gameplay_utils/number_events
  • Modify parameters in route /gameplay_utils/event_stats:
    • remove use of parameters _ids and _uids (only use _id and _uid)
    • remove "mode" parameter with "group_by". Group by data with attributes in Array style (ex: ["student_id", "knowledge_node_id", "month"])
  • Add new route /gameplay_utils/validation_progress to replace /gameplay_utils/(get_progress,get_concept_progress,get_precise_progress,progress_for_objectives,concept_mastery)
  • Improve speed of routes /recommendationutils/fetch_best(content/evaluation)_recommendations
  • Modify Authentification errors with more explicit descriptions

Bug Fixes:

  • Fix GET request /objective_knowledge_nodes
  • Fix update of errors_theta in case new difficulty levels are added

v2.1.7 (17/12/2020)

New Features / Improvements:

Bug Fixes:

  • Fix Recommendation of Learning Contents when looking for contents in other KnowledgeNodes
  • Fix Initialization of Objectives in some cases
  • Fix Event processing when associations are lost

v2.1.6 (08/12/2020)

New Features / Improvements:

  • Improve initialization speed for Memorize and Adaptive Objectives
  • Optimize speed for following routes:
    • /review_utils/fetch_reviews route
    • /user_model_utils/ai_training_status
    • /user_model_utils/ai_training_feedbacks

Bug Fixes:

  • Fix error message output when request have Invalid or Expired Tokens
  • Fix Recommendation of Learning Contents when no Learning Contents available

v2.1.5 (02/12/2020)

New Features / Improvements:

  • Standardize all error response outputs. All JSON responses will have an error attribute and inside you will have two sub-attributes:
    • message: You will have a message explaining the cause of the problem that occured.
    • status: The status code of the request

Bug Fixes:

  • Fix filtering Contents in case of adaptive Objective.
  • Fix Recommendation of Evaluation Contents in certain cases.
  • Fix validation of KnowledgeNode in streak mode when threshold is negative or equal to 0. Now directly validates KnowledgeNode after first Event.

v2.1.4 (20/11/2020)

New Features / Improvements:

  • Add parameter "content_limit" in recommendation routes to define limit number of contents recommended for a KnowledgeNode.

Bug Fixes:

  • Fix Recommendation of Evaluation and Learning Contents in certain cases.
  • Fix Processing of EventRating when no specific attributes are put inside payload.
  • Fix Compute of new review dates when learning profile is not initialized yet.

v2.1.3 (16/11/2020)

New Features / Improvements:

  • Add new route to get number of Events with different scoping and grouping possibilities

Bug Fixes:

  • Fix "page" parameter in GET routes when used as URL parameter

v2.1.2 (10/11/2020)

New Features / Improvements:

  • Add parameter "validation_thresholds" when creating Objective to specify a validation threshold by KnowledgeNode ID or UID.
  • Add parameter "return_all" in route /recommendation_utils/fetch_best_learning_recommendations to fetch all the recommendations

Bug Fixes:

  • Fix input parameters of type JSON that have not been considered in the creation of certain Objects.
  • Fix processing of Event of type "EventResult" in specific cases.

v2.1.0 (27/10/2020)

🎉 The version 2.1.0 of the API is the starting point of the API Changelog ! 🎉

New Features / Improvements:

  • Add Timeout Error 503 for specific routes when the request is taking too long.
  • Add new type of Event ("EventRating") to rate content from different angles like relevance, impact on the student progress...
  • Add a confidence score for learning and evaluation Recommendations.
  • Improvement of the creation/initialization speed of internal objects (KNS and OKNS) necessary to setup the learning and memorization objectives.
  • Improvement of the CAT algorithm processing speed.

Bug Fixes:

  • Fix GameplayUtils routes that use "knowledge_graph_uids" parameter.
  • Fix processing of the mastery score in specific cases.
  • Fix stats processing for Events of type "EventRead" in /gameplay_utils/event_stats when working with attempts.