acdh-oeaw / arche-openrefine
OpenRefine API implementation on top of the ARCHE Suite
Installs: 1 631
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^8.1
- zozlak/query-part: ^2.1
Requires (Dev)
README
Implementation of the OpenRefine APIs for the ARCHE Suite.
Allows to use the ARCHE Suite as a reconciliation backend for the OpenRefine.
Supported features
- Reconcile endpoint based on the full text search over the repository content
- Preview endpoint implemented as a a redirection to the
{repositoryApiBaseURL}/{resourceId}/metadata
- Suggest endpoint for entities, properties and types
Scoring algorithm
- As match is made against a metadata property value first a property match score is computed.
- Property weights are defined in the
propertyWeights
configuration property (see theconfig-sample.yaml
). If property weight isn't provided in the config, it's assumed to be1
. - If match is only partial (query phrase is only a part of the property value),
the weight is multiplied by the
partialMatchCoefficient
configuration property.
- Property weights are defined in the
- On a resource level the score is the sum of scores for all of its property matches.
Installation
- Obtain the composer.
-
composer require acdh-oeaw/arche-openrefine ln -s vendor/acdh-oeaw/arche-openrefine/index.php index.php cp vendor/acdh-oeaw/arche-openrefine/config-sample.yaml config.yaml cp vendor/acdh-oeaw/arche-openrefine/.htaccess .htaccess # apache-only
- Adjust settings in
config.yaml
Sample instance
A sample instance which is running on top of the ARCHE repository has its manifest at https://arche.acdh.oeaw.ac.at/openrefine/reconcile.