-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathutils.py
349 lines (302 loc) · 16 KB
/
utils.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
import pandas as pd
import os
import re
from openai import OpenAI
from dotenv import load_dotenv
load_dotenv()
OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
openai_client = OpenAI()
OPENAI_SYSTEM_MESSAGE = """"You are a helpful assistant."""
def call_openai(prompt, modelId="gpt-4o", temperature=0.5, max_tokens=4096):
try:
completion = openai_client.chat.completions.create(
model=modelId,
temperature=temperature,
max_tokens=max_tokens,
messages=[
{"role": "system", "content": OPENAI_SYSTEM_MESSAGE},
{"role": "user", "content": prompt},
],
)
return completion.choices[0].message.content
except Exception as e:
print(f"Error: {e}")
return None
PROMPT_ANOMALIES = """Du bist Experte für Datenqualität und sollst einen Datenkatalog überprüfen. Du erhältst eine kommagetrennte Liste von {feature} aller Datensätze im Katalog. Du sollst die Beschreibungen auf Anomalien prüfen. Hier ist die kommagetrennte Liste von {feature} der Datensätze:
<datensatz-{feature}>
{data}
</datensatz-{feature}>
Prüfe nun, ob es Anomalien oder sonstige Auffälligkeiten in den {feature} gibt. Bitte liste alle Anomalien auf, die du findest, zitiere passende Beispiele und kommentiere kurz, warum diese ein Problem sind."""
def check_text_properties(feature, data):
"""Check the text properties of the titles and descriptions of the datasets globally. Each will be provided to the LLM as a comma-separated list. The analysis will be done in one go, not per dataset."""
return call_openai(PROMPT_ANOMALIES.format(feature=feature, data=data))
SYSTEM_MESSAGE = """"Du bist ein hilfreicher Assistent für ein Statistikamt. Du wirst gebeten, Metadaten für einen Datensatz zu analysieren. Bleibe stets wahrheitsgemäß und objektiv. Schreib nur das, was du anhand der vom Benutzer bereitgestellten Metadaten sicher feststellen kannst. Mache keine Annahmen. Schreibe einfach und klar. Schreibe immer in deutscher Sprache."""
PROMPT_ANALYSIS = """Du erhältst die Metadaten eines Datensatzes. Diese sollst du detailliert und genau analysieren. Die Metadaten bestehen aus einem Titel und einer Beschreibung. Du sollst die Metadaten analysieren und sicherstellen, dass diese aussagekräftig, vollständig und von hoher Qualität sind.
Analysiere Schritt für Schritt die Metadaten nach folgenden Kriterien:
1. Dateninhalt - Wie detailliert und eindeutig erklären Titel und Beschreibung, worum es in dem Datensatz geht?
2. Methodik - Wie detailliert und eindeutig erklären Titel und Beschreibung, wie die Daten gemessen wurden und wofür? Wird die Quelle der Daten genannt und beschrieben?
3. Datenqualität - Wie detailliert und eindeutig erklären Titel und Beschreibung, wie gut die Qualität der Daten ist? Wird erklärt, wie vollständig die Daten sind? Gibt es Änderungen in der Erhebung?
4. Geographie - Wie detailliert und eindeutig erklären Titel und Beschreibung, wie die Daten geographisch zu verstehen sind? Wird klar, auf welche geographischen Orte oder Gebiete sich die Daten beziehen?
Prüfe bei jedem Punkt auch, ob es Auffälligkeiten oder Anomalien gibt und bennene diese kurz. Das können zum Beispiel sein:
- fehlende Informationen,
- schwer verständliche oder vieldeutige Begriffe,
- unnötige und unklare Abkürzungen,
- Rechtschreibfehler oder uneinheitliche Schreibweisen,
- ungewöhnliche Zeichen, Symbole oder Formatierungen,
- Tags, Markdown, HTML-Code oder andere Programmierzeichen,
- unklare oder unvollständige Sätze oder Absätze,
- keine geschlechtergerechte Sprache.
Hier ein Beispiel:
Titel: Web Analytics der Open Government Data des Kantons Zürich auf opendata.swiss von Februar 2018 bis Februar 2021
Beschreibung: Monatliche Nutzungsstatistiken (Anzahl Besuche) der Open Government Data (OGD) Metadatensätze von Verwaltungseinheiten und Organen des Kantons Zürich, die auf dem zentralen Katalog für offene Behördendaten opendata.swiss findbar sind. Hinweise: Ab Januar 2019 sind die Web Analytics um weitere Metadateninformationen erweitert bzw. wurden Metadatenanpassungen vorgenommen. Ab März 2021 sind die monatlichen Aktualisierungen aufgrund technischer Herausforderungen pausiert. Variablendefinitionen: Column 'name' = dataset slug; 'issued' = first publication of dataset; 'organization_name' = publisher slug; 'organization_url' = publisher URL; 'E' up to 'AB' = thematic categories according to DCAT AP Switzerland.
Dateninhalt: Detaillierte und eindeutige Erklärung, worum es in dem Datensatz geht.
Methodik: Detaillierte und eindeutige Erklärung, wie die Daten gemessen wurden und wofür. Variablendefinitionen sind klar und detailliert. -> 4 Punkte
Datenqualität: Einige Hinweise auf die Qualität der Daten, ebenso Angaben zur Vollständigkeit und zu Änderungen in der Erhebung. -> 4 Punkte
Geographie: Keine spezifischen Angaben zu geographischen Orten oder Gebieten. -> 1 Punkt
Hier ein weiteres Beispiel:
Titel: Kühe [Anz.]
Beschreibung: Anzahl Kühe
Dateninhalt: Es ist nicht klar, welche Daten genau erfasst werden. Eine detaillierte Beschreibung der Daten fehlt völlig. -> 2 Punkte
Methodik: Es gibt keine Informationen darüber, wie die Daten gemessen wurden und wofür. -> 1 Punkt
Datenqualität: Es gibt keine Informationen zur Qualität der Daten. -> 1 Punkt
Geographie: Es gibt keine Informationen zum räumlichen Bezug. -> 1 Punkt
Gibt das Ergebnis deiner Analyse in XML-Tags aus, in dieser Form:
<dateninhalt> ... </dateninhalt>
<methodik> ... </methodik>
<datenqualität> ... </datenqualität>
<geographie> ... </geographie>
Vergib dann eine Bewertung für jedes der vier Kriterien.
Verwende die Skala von 1-5, wobei 1 die schlechteste und 5 die beste Bewertung ist.
Sei klar, hart und kritisch bei deiner Bewertung.
Hier ist die Bewertungsskala:
1 Punkt - Keine Informationen zu diesem Kriterium.
2 Punkte - Wenige Informationen, viel fehlt.
3 Punkte - Mittelmässige Informationen, einige Informationen sind vorhanden, einiges fehlt.
4 Punkte - Gute Informationen, die meisten Informationen sind vorhanden.
5 Punkte - Exzellente Informationen, alles ist sehr klar, vollständig und detailliert.
Gib die Bewertung in XML-Tags aus, in dieser Form:
<dateninhalt-score> ... </dateninhalt-score>
<methodik-score> ... </methodik-score>
<datenqualität-score> ... </datenqualität-score>
<geographie-score> ... </geographie-score>
Analysiere und bewerte jetzt die Metadaten des Datensatzes.
Hier sind die Metadaten des Datensatzes, den du analysieren sollst:
---------------------------------------------------------------------
Titel: {title}
Beschreibung: {description}
"""
def do_full_analysis(data):
"""Check the titles and descriptions of each dataset individually."""
return call_openai(
PROMPT_ANALYSIS.format(title=data.title, description=data.description)
)
def parse_analysis_results(results):
"""Parse the LLM response. Extract the scores and the qualitative analysis.
Args:
results (str): The response from the LLM.
Returns:
pd.DataFrame: A DataFrame with the scores and the qualitative analysis.
"""
content = re.findall(r"<dateninhalt>(.*?)</dateninhalt>", results, re.DOTALL)[
0
].strip()
content_score = re.findall(
r"<dateninhalt-score>(.*?)</dateninhalt-score>", results, re.DOTALL
)[0].strip()
context = re.findall(
r"<methodik>(.*?)</methodik>",
results,
re.DOTALL,
)[0].strip()
context_score = re.findall(
r"<methodik-score>(.*?)</methodik-score>",
results,
re.DOTALL,
)[0].strip()
quality = re.findall(r"<datenqualität>(.*?)</datenqualität>", results, re.DOTALL)[
0
].strip()
quality_score = re.findall(
r"<datenqualität-score>(.*?)</datenqualität-score>",
results,
re.DOTALL,
)[0].strip()
spacial = re.findall(
r"<geographie>(.*?)</geographie>",
results,
re.DOTALL,
)[0].strip()
spacial_score = re.findall(
r"<geographie-score>(.*?)</geographie-score>",
results,
re.DOTALL,
)[0].strip()
tmp = pd.DataFrame(
(
content,
content_score,
context,
context_score,
quality,
quality_score,
spacial,
spacial_score,
)
).T
tmp.columns = [
"content",
"content_score",
"context",
"context_score",
"quality",
"quality_score",
"spacial",
"spacial_score",
]
return tmp
# Data derived from the DCAT-AP CH specification here:
# https://www.dcat-ap.ch/releases/2.0/dcat-ap-ch.html#Class:Dataset
DCAT_CLASS_DATASET = [
("contact point", "dcat:contactPoint", "vcard:Kind", "M", "1..n"),
("description", "dct:description", "rdfs:Literal", "M", "1..n"),
("identifier", "dct:identifier", "rdfs:Literal", "M", "1..n"),
("publisher", "dct:publisher", "foaf:Agent", "M", "1..1"),
("Title", "dct:title", "rdfs:Literal", "M", "1..n"),
("dataset distribution", "dcat:distribution", "dcat:Distribution", "R", "0..n"),
("keyword/tag", "dcat:keyword", "rdfs:Literal", "R", "0..n"),
("landing page", "dcat:landingPage", "foaf:Document", "R", "0..n"),
(
"release date",
"dct:issued",
"rdfs:Literal (typed as xsd:date, xsd:dateTime, xsd:gYear or xsd:gYearMonth)",
"R",
"0..1",
),
("spatial/ geographical coverage", "dct:spatial", "dct:Location", "R", "0..n"),
("temporal coverage", "dct:temporal", "dct:PeriodOfTime", "R", "0..n"),
("theme/category", "dcat:theme", "skos:Concept", "R", "0..n"),
(
"update/ modification date",
"dct:modified",
"rdfs:Literal (typed as xsd:date, xsd:dateTime, xsd:gYear or xsd:gYearMonth)",
"R",
"0..1",
),
("access rights", "dct:accessRights", "dct:RightsStatement", "O", "0..1"),
("conforms to", "dct:conformsTo", "dct:Standard", "O", "0..n"),
("documentation", "foaf:page", "foaf:Document", "O", "0..n"),
("frequency", "dct:accrualPeriodicity", "dct:Frequency", "O", "0..1"),
("image", "schema:image", "schema:url or schema:ImageObject", "O", "0..3"),
("is referenced by", "dct:isReferencedBy", "rdfs:Resource", "O", "0..n"),
("language", "dct:language", "dct:LinguisticSystem", "O", "0..n"),
(
"qualified attribution",
"prov:qualifiedAttribution",
"prov:Attribution",
"O",
"0..n",
),
("qualified relation", "dcat:qualifiedRelation", "dcat:Relationship", "O", "0..n"),
("related resource", "dct:relation", "rdfs:Resource", "O", "0..n"),
]
DCAT_CLASS_DISTRIBUTION = data = [
("dcat:accessURL", "rdfs:Resource", "M", "1..n"),
("dct:license", "dct:LicenseDocument", "M", "1..1"),
("dcatap:availability", "skos:Concept", "R", "0..1"),
("dct:description", "rdfs:Literal", "R", "0..n"),
("dct:format", "dct:MediaTypeOrExtent", "R", "0..1"),
("dct:rights", "dct:RightsStatement", "R", "0..1"),
("dct:title", "rdfs:Literal", "R", "0..n"),
(
"dct:modified",
"rdfs:Literal (typed as xsd:date, xsd:dateTime, xsd:gYear or xsd:gYearMonth)",
"R",
"0..1",
),
("dcat:accessService", "dcat:DataService", "O", "0..n"),
("dcat:byteSize", "rdfs:Literal (typed as xsd:decimal)", "O", "0..1"),
("spdx:checksum", "spdx:Checksum", "O", "0..1"),
("dct:coverage", "LocationPeriodOrJurisdiction", "O", "0..n"),
("foaf:page", "foaf:Document", "O", "0..n"),
("dcat:downloadURL", "rdfs:Resource", "O", "0..n"),
("dct:identifier", "rdfs:Literal", "O", "0..1"),
("schema:image", "schema:url or schema:ImageObject", "O", "0..3"),
("dct:language", "dct:LinguisticSystem", "O", "0..n"),
("dct:conformsTo", "dct:Standard", "O", "0..n"),
("dcat:mediaType", "dct:MediaType", "O", "0..1"),
("dcat:packageFormat", "dcat:mediaType", "O", "0..1"),
(
"dct:issued",
"rdfs:Literal (typed as xsd:date, xsd:dateTime, xsd:gYear or xsd:gYearMonth)",
"R",
"0..1",
),
("dcat:temporalResolution", "xsd:duration", "R", "0..1"),
]
# Data derived from here:
# https://publications.europa.eu/resource/authority/data-theme
VOCAB_EU_THEME = [
"http://publications.europa.eu/resource/authority/data-theme/TECH",
"http://publications.europa.eu/resource/authority/data-theme/TRAN",
"http://publications.europa.eu/resource/authority/data-theme/REGI",
"http://publications.europa.eu/resource/authority/data-theme/SOCI",
"http://publications.europa.eu/resource/authority/data-theme/AGRI",
"http://publications.europa.eu/resource/authority/data-theme/ECON",
"http://publications.europa.eu/resource/authority/data-theme/JUST",
"http://publications.europa.eu/resource/authority/data-theme/OP_DATPRO",
"http://publications.europa.eu/resource/authority/data-theme/HEAL",
"http://publications.europa.eu/resource/authority/data-theme/INTR",
"http://publications.europa.eu/resource/authority/data-theme/ENVI",
"http://publications.europa.eu/resource/authority/data-theme/GOVE",
"http://publications.europa.eu/resource/authority/data-theme/EDUC",
"http://publications.europa.eu/resource/authority/data-theme/ENER",
]
# Data derived from here:
# https://publications.europa.eu/resource/authority/frequency
VOCAB_EU_FREQUENCY = [
"http://publications.europa.eu/resource/authority/frequency/BIDECENNIAL",
"http://publications.europa.eu/resource/authority/frequency/TRIDECENNIAL",
"http://publications.europa.eu/resource/authority/frequency/BIHOURLY",
"http://publications.europa.eu/resource/authority/frequency/TRIHOURLY",
"http://publications.europa.eu/resource/authority/frequency/OTHER",
"http://publications.europa.eu/resource/authority/frequency/WEEKLY",
"http://publications.europa.eu/resource/authority/frequency/HOURLY",
"http://publications.europa.eu/resource/authority/frequency/QUADRENNIAL",
"http://publications.europa.eu/resource/authority/frequency/QUINQUENNIAL",
"http://publications.europa.eu/resource/authority/frequency/DECENNIAL",
"http://publications.europa.eu/resource/authority/frequency/WEEKLY_2",
"http://publications.europa.eu/resource/authority/frequency/WEEKLY_3",
"http://publications.europa.eu/resource/authority/frequency/UNKNOWN",
"http://publications.europa.eu/resource/authority/frequency/UPDATE_CONT",
"http://publications.europa.eu/resource/authority/frequency/QUARTERLY",
"http://publications.europa.eu/resource/authority/frequency/TRIENNIAL",
"http://publications.europa.eu/resource/authority/frequency/NEVER",
"http://publications.europa.eu/resource/authority/frequency/OP_DATPRO",
"http://publications.europa.eu/resource/authority/frequency/MONTHLY_2",
"http://publications.europa.eu/resource/authority/frequency/MONTHLY_3",
"http://publications.europa.eu/resource/authority/frequency/IRREG",
"http://publications.europa.eu/resource/authority/frequency/MONTHLY",
"http://publications.europa.eu/resource/authority/frequency/DAILY",
"http://publications.europa.eu/resource/authority/frequency/DAILY_2",
"http://publications.europa.eu/resource/authority/frequency/BIWEEKLY",
"http://publications.europa.eu/resource/authority/frequency/CONT",
"http://publications.europa.eu/resource/authority/frequency/BIENNIAL",
"http://publications.europa.eu/resource/authority/frequency/BIMONTHLY",
"http://publications.europa.eu/resource/authority/frequency/ANNUAL_2",
"http://publications.europa.eu/resource/authority/frequency/ANNUAL_3",
"http://publications.europa.eu/resource/authority/frequency/ANNUAL",
"http://publications.europa.eu/resource/authority/frequency/NOT_PLANNED",
"http://publications.europa.eu/resource/authority/frequency/AS_NEEDED",
]
# These are values for «hidden» nulls. These values satisfy the DCAT standard, because they are not empty. However, they are not useful or meaningful.
HIDDEN_NULLS = (
"",
"null",
"[]",
"{}",
"nan",
"none",
"ohne angabe",
"keine angabe",
"nichts",
)