eoscfuture.eu intern EOSC-IF AI/ML Recommender System Interoperabilty Guideline

eoscfuture.eu AI/ML Recommender System Interoperabilty Guideline Version 1.0 July 2023 EOSC-IF / AI/ML Recommender System Interoperability Guideline Lead by PSNC Authored by Marcin Wolski (PSNC), Krzysztof Martyn (PSNC), Maciej Łabędzki (PSNC), Michail Xydas (Athena), Themis Zamani (GRNET), Bartosz Walter (PSNC), John Shepherdson (CESSDA), Michal Kolomanski (Cyfronet), Nikolaos Triantafyllis (GRNet) Reviewed by Aggelikki Gkamiliari (Athena), George Papastefanatos (Athena), Thanassis Mantes (Athena), Pavel Weber (KIT) Dissemination Level of the Document Public Document Identifier https://doi.org/10.5281/zenodo.7849178 Abstract This document describes the current architecture of the EOSC Recommendation System and provides guidelines for three integration options with external service components.

eoscfuture.eu AI/ML Recommender System Interoperabilty Guideline 1 Version History Version Date Authors/Contributors Description V0.1 20/04/2023 Marcin Wolski (PSNC), Krzysztof Martyn (PSNC), Maciej Łabędzki (PSNC), Michail Xydas (Athena), Themis Zamani (GRNET), Bartosz Walter (PSNC), John Shepherdson (CESSDA), Michal Kolomanski (Cyfronet), Nikolaos Triantafyllis (GRNet) First draft V0.2 21/04/2023 Raimundas Tuminauskas (PSNC) Review, minor corrections V0.3 21/04/2023 John Shepherdson (CESSDA) Updated and submitted to EIAC V0.4 07/06/2023 John Shepherdson (CESSDA), Marcin Wolski (PSNC), Krzysztof Martyn (PSNC), Maciej Łabędzki (PSNC), Michal Kolomanski (Cyfronet), Responded to substantive review comments V1.0 18/07/2023 Marcin Wolski (PSNC), Krzysztof Martyn (PSNC), Maciej Łabędzki (PSNC), Michail Xydas (Athena), Themis Zamani (GRNET), Bartosz Walter (PSNC), John Shepherdson (CESSDA), Michal Kolomanski (Cyfronet), Nikolaos Triantafyllis (GRNet) Final Version, uploaded to Zenodo Copyright Notice This work by Parties of the EOSC Future Consortium is licensed under a Creative Commons Attribution 4.0 International License. The EOSC Future project is co- funded by the European Union Horizon Programme call INFRAEOSC-03-2020, Grant Agreement number 101017536.

eoscfuture.eu AI/ML Recommender System Interoperabilty Guideline 2 Table of Contents Glossary ........................................................................................................................................... 4 List of Abbreviations ......................................................................................................................... 5 1 Intended Audience ..................................................................................................................... 6 2 Description and main features ..................................................................................................... 6 3 Response to Community Need .................................................................................................... 6 4 High-level Service Architecture .................................................................................................... 7 4.1 Evaluation framework ............................................................................................. 8 5 Definitions ................................................................................................................................. 9 6 Licensing Information ................................................................................................................. 9 7 Related Guidelines ..................................................................................................................... 9 8 Adopted Standards .................................................................................................................... 9 9 Integration Options .................................................................................................................. 10 10 Interoperability Guidelines ........................................................................................................ 10 10.1 Scenario 1 – adding a new client .......................................................................... 11 10.1.1 Integration with RS Facade .......................................................................................................... 11 10.1.2 Integration with the Databus ....................................................................................................... 11 10.2 Scenario 2: adding a new recommendation engine ............................................... 12 10.2.1 Step 1: Integration with data sources ........................................................................................... 12 10.2.1.1 Information available from the Search Service ................................................................. 12 10.2.1.2 Information available from the databus ............................................................................ 13 10.2.1.3 Information available from internal databases ................................................................. 13 10.2.2 Step 2: Integration with the Facade ............................................................................................. 13 10.3 Evaluating a new integration ............................................................................... 13 11 Examples of solutions implementing this specification ................................................................. 13 11.1 Scenario 1 example ............................................................................................. 13 11.2 Scenario 2 example ............................................................................................ 14 11.3 Scenario 3 example ............................................................................................ 14 12 Appendix A – RS Facade ............................................................................................................. 15 12.1 RS Façade Endpoints ......................................................................................... 15 12.1.1 Recommendations endpoint ....................................................................................................... 15 12.1.2 Response from connected recommendation engines .................................................................. 17 12.1.3 Project completion endpoint ....................................................................................................... 18 12.1.4 Similar services endpoint ............................................................................................................. 18 12.1.5 Similar resources endpoint .......................................................................................................... 19 12.1.6 Databus messages ....................................................................................................................... 19 12.1.7 Example of request body for commendations endpoint ............................................................... 20 12.1.8 Example of request body for project completion endpoint: ......................................................... 21 12.1.9 Example of request body for similar services endpoint: ................................................................ 21 12.1.10 Example of request body for similar resources endpoint: ............................................................ 21 13 Appendix B – Databus ................................................................................................................ 21 13.1 Databus messages ............................................................................................. 21 13.1.1 Marketplace database events ...................................................................................................... 21

eoscfuture.eu AI/ML Recommender System Interoperabilty Guideline 3 13.1.1.1 Create new user ............................................................................................................... 21 13.1.1.2 Update user ..................................................................................................................... 21 13.1.1.3 Update service ................................................................................................................. 22 13.1.1.4 Update ScientificDomain ................................................................................................. 22 13.2 Recommendations ............................................................................................. 22 13.2.1 Examples ..................................................................................................................................... 23 For a query for one resource type: ................................................................................................... 23 For a query for all resource types: .................................................................................................... 23 References ....................................................................................................................................... 27 Table of Tables Table 7-1: Related Guidelines ............................................................................................................................ 9 Table 8-1: Adopted Standards ........................................................................................................................ 10 Table 10-1: EOSC-RS integration points ......................................................................................................... 10 Table 12-1: Recommendation context ............................................................................................................ 16 Table 12-2: Recommendation candidates ....................................................................................................... 16 Table 12-3: Recommendation SearchData ...................................................................................................... 16 Table 12-4: Recommendation response .......................................................................................................... 17 Table 12-5: RecommendationSet ................................................................................................................... 17 Table 12-6: Databus message ......................................................................................................................... 17 Table 12-7: Recommendation source .............................................................................................................. 18 Table 12-8: Project completion recommendation request .............................................................................. 18 Table 12-9: Project completion recommendation response ............................................................................ 18 Table 12-10: Similar services recommendation request .................................................................................. 18 Table 12-11: Similar services recommendation response ................................................................................ 18 Table 12-12: Similar resource suggestion request ........................................................................................... 19 Table 12-13: RS Facade databus message - recommendations received .......................................................... 19 Table 12-14: RS Facade databus message – recommendation source details .................................................. 19 Table 13-1: Recommendations message sent by RS Facade to Databus .......................................................... 22 Table 13-2: Recommendation Context ............................................................................................................ 22 Table 13-3: Recommendation source .............................................................................................................. 23 Table of Figures Figure 4.1: EOSC-RS high-level architecture ..................................................................................................... 8 Figure 4.2: Recommender Metrics Framework architecture ............................................................................. 9 Figure 10.1: integration points for a new EOSC-RS client ................................................................................ 11 Figure 10.2: integrating a new data source with the EOSC-RS ........................................................................ 12 Figure 12.1: RS Facade general scheme of operation ...................................................................................... 15

eoscfuture.eu AI/ML Recommender System Interoperabilty Guideline 4 Glossary EOSC Future project Glossary is incorporated by reference: https://wiki.eoscfuture.eu/x/JQCK

eoscfuture.eu AI/ML Recommender System Interoperabilty Guideline 5 List of Abbreviations Acronym Definition API Application Programming Interface EOSC-RS EOSC Recommender System