Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PKG connector documentation #114

Merged
merged 4 commits into from
May 10, 2024
Merged

PKG connector documentation #114

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e6faea
PKG connector documentation
NoB0 Apr 3, 2024
b3a1fd1
Address review comments
NoB0 May 6, 2024
741fac5
Merge branch 'main' into feature/108-Add-documentation-on-PKG-connector
NoB0 May 10, 2024
61feff4
Address review comments
NoB0 May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/source/pkg_connector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
PKG Connector
=============

This component is responsible for establishing a connection to the PKG and executing SPARQL queries against it.
The SPARQL queries are generated based on the user's annotated statements using utility functions (see :py:mod:`pkg_api.utils`).

Features
--------

The PKG Connector has the following features:

- Loading and saving the PKG
- Binding the namespaces related to the PKG vocabulary (see complete list `here <https://iai-group.github.io/pkg-vocabulary/>`)
- Executing SPARQL queries against the PKG

The PKG Connector uses the `RDFLib <https://github.com/RDFLib/rdflib>` library to handle the PKG and execute SPARQL queries. For this reason, we differentiate between two types of SPARQL queries: (1) queries to update the PKG, such as adding and removing statements, and (2) queries to retrieve information from the PKG.

SPARQL Queries
--------------

The SPARQL queries are automatically generated based on the user's annotated statements and templates.

- **Insertion queries** for adding statements or preferences to the PKG, the templates are defined in :py:func:`pkg_api.utils.get_query_for_add_statement` and :py:func:`pkg_api.utils.get_query_for_add_preference` respectively.
- **Deletion queries** for removing statements or preferences from the PKG, the templates are defined in :py:func:`pkg_api.utils.get_query_for_remove_statement` and :py:func:`pkg_api.utils.get_query_for_remove_preference` respectively. Additionally, a query to remove dangling objects is provided.
- **Retrieval queries** for retrieving statements or preferences from the PKG, the templates are defined in :py:func:`pkg_api.utils.get_query_for_get_statements` and :py:func:`pkg_api.utils.get_query_for_get_preferences` respectively. For more flexibility, templates for retrieving statements and preferences based on specific criteria are also provided, see :py:func:`pkg_api.utils.get_query_for_conditional_get_statements` and :py:func:`pkg_api.utils.get_query_for_conditioned_get_preference`.

All templates are defined in the `pkg_api.utils <https://github.com/iai-group/pkg-api/blob/main/pkg_api/utils.py>` module.
Loading