Skip to content

AGAPI

getAllKg()

Retrieve metadata of all KGs that are automatically discoverable from LODC and DataHub.

Returns:

Name Type Description
list

A list of dictionaries representing the metadata of all KGs.
Source code in kgheartbeat\AGAPI.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def getAllKg():
    """Retrieve metadata of all KGs that are automatically discoverable from LODC and DataHub.

    Returns:
        list: A list of dictionaries representing the metadata of all KGs.
    """

    url = 'https://kgs-search-engine.herokuapp.com/brutalSearch?keyword='
    try:
        response = requests.get(url)    
        if response.status_code == 200:
            print("Connection to API successful and data recovered")
            response = response.json()
            results = response.get('results')
            return results
        else:
            print("Connection failed")
            return False
    except:
        print('Connection failed')
        return False

getIdByName(keyword)

Get the ID of the KG from its name.

Parameters:

Name Type Description Default
keyword string

The name or keyword of the KG.

 required

Returns:

Name Type Description
list

A list of KG IDs matching the keyword.
Source code in kgheartbeat\AGAPI.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def getIdByName(keyword):
    """Get the ID of the KG from its name.

    Args:
        keyword (string): The name or keyword of the KG.

    Returns:
        list: A list of KG IDs matching the keyword.
    """
    url = 'https://kgs-search-engine.herokuapp.com/brutalSearch?keyword=%s'%keyword
    try:
        response = requests.get(url)    
        if response.status_code == 200:
            print("Connection to API successful and data recovered")
            response = response.json()
            results = response.get('results')
            kgfound = []
            for i in range(len(results)):
                d = results[i]
                id = d.get('id')
                kgfound.append(id)
            return kgfound
        else:
            print("Connection failed")
            return False
    except:
        print('Connection failed')
        return False

getMetadati(idKG)

Find the metadata about a KG from its id.

Parameters:

Name Type Description Default
idKG string

A string that represent the ID of KG that we want the metadata.

 required

Returns:

Name Type Description
string

A string that represent the metadata of the KG.
Source code in kgheartbeat\AGAPI.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def getMetadati(idKG):
    """Find the metadata about a KG from its id.

    Args:
        idKG (string): A string that represent the ID of KG that we want the metadata.

    Returns:
        string: A string that represent the metadata of the KG.
    """

    url = 'https://kgs-search-engine.herokuapp.com/brutalSearch?keyword=%s'%idKG
    try:
        response = requests.get(url)    
        if response.status_code == 200:
            response = response.json()
            results = response.get('results')
            return results
        else:
            print("Connection failed to AGAPI")
            return False
    except:
        print('Connection failed to AGAPI')
        return False

getNameKG(metadata)

Extract the full name of the KG from the metadata.

Parameters:

Name Type Description Default
metadata dict

The metadata of a KG.

 required

Returns:

Name Type Description
string

The full name of the KG.
Source code in kgheartbeat\AGAPI.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def getNameKG(metadata):
    """Extract the full name of the KG from the metadata.

    Args:
        metadata (dict): The metadata of a KG.

    Returns:
        string: The full name of the KG.
    """

    if isinstance(metadata,dict):
        title = metadata.get('title')
        return title
    else: 
        return False

getSparqlEndpoint(metadata)

Extract the SPARQL endpoint URL from the metadata.

Parameters:

Name Type Description Default
metadata dict

The metadata of a KG.

 required

Returns:

Name Type Description
string

The URL of the SPARQL endpoint.
Source code in kgheartbeat\AGAPI.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def getSparqlEndpoint(metadata):
    """Extract the SPARQL endpoint URL from the metadata.

    Args:
        metadata (dict): The metadata of a KG.

    Returns:
        string: The URL of the SPARQL endpoint.
    """

    if isinstance(metadata,dict):
        sparqlInfo = metadata.get('sparql')
        if not sparqlInfo:
            return False
        accessUrl = sparqlInfo.get('access_url')
        return accessUrl