Difference between revisions of "Help:OpenRefine’s reconciliation endpoint"
(Created page with " A reconciliation service endpoint allows tools like OpenRefine to match (“reconcile”) strings (e.g. names) in your data to entities in Canonbase. You can match your ite...") |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
| − | A. Step-by-step instructions for adding endpoint to OpenRefine | + | == A. Step-by-step instructions for adding endpoint to OpenRefine == |
| − | + | ||
| − | + | * Open your project: Open the OpenRefine project containing the data you want to reconcile. | |
| − | + | * Select a column: Choose the column header for the data (like names or places) that you want to reconcile against an external service. | |
| − | + | * Start the reconciliation process: Click on the drop-down menu for that column. | |
| − | + | * Select "Start reconciling": Hover over Reconcile and then select Start reconciling from the menu. | |
| − | + | * Add a new service: In the window that appears, click the Add Standard Service button, usually found in the bottom-left corner. | |
| − | + | * Input the service URL: A new window will open with a textbox to enter the service's URL. The url is | |
| − | + | ||
| + | https://reconcile.purkertlab.cz/en/api | ||
| + | , where you may adjust language by replacing language code: i.e. for instance | ||
| + | https://reconcile.purkertlab.cz/fr/api for French | ||
| + | |||
| + | * Add the service: Paste the specific reconciliation URL (into the box and click Add Service. | ||
| + | * Use the service: The newly added service will appear in the list, and you can now select it to start matching your data against the remote service. | ||
| Line 19: | Line 25: | ||
Detailed description is available at https://openrefine.org/docs/manual/reconciling | Detailed description is available at https://openrefine.org/docs/manual/reconciling | ||
| − | + | == B/ uploading data with OpenRefine == | |
| − | |||
| − | B/ uploading data with OpenRefine | ||
for uploading, one has to be logged in to Canonbase in OpenRefine. | for uploading, one has to be logged in to Canonbase in OpenRefine. | ||
| + | ==== Steps to Add a Reconciliation Manifest ==== | ||
| − | |||
| + | * Open the Wikibase Extension Menu: In your OpenRefine project, find the "Wikibase" menu in the top right corner of the window. | ||
| + | * Select "Add Wikibase": | ||
| + | * From the dropdown menu, choose "Select Wikibase instance…" and then click the "Add Wikibase" button. | ||
| + | * Provide the Manifest URL or JSON: | ||
| + | - For a URL: Copy the manifest's URL https://reconcile.purkertlab.cz/static/manifest.json and paste it into the provided field. | ||
| + | - Or with below code, copy its content, and paste it into the text box that appears after clicking "Add Wikibase". | ||
| + | '''The manifest to be pasted: ''' | ||
| + | <nowiki> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{ | { | ||
"version": "2.0", | "version": "2.0", | ||
| Line 82: | Line 85: | ||
} | } | ||
} | } | ||
| + | |||
| + | </nowiki> | ||
| + | |||
| + | * Activate the Service: The new Wikibase instance will appear in the list. Click its name (e.g., "Wikimedia Commons") to select and activate it. | ||
| + | * Close the Dialog: Click the "Close" button to close the dialog window. | ||
| − | + | The service now should be able to upload, after you are logged in into the Canonbase. | |
| − | |||
| − | |||
| − | |||
Latest revision as of 09:14, 15 September 2025
A reconciliation service endpoint allows tools like OpenRefine to match (“reconcile”) strings (e.g. names) in your data to entities in Canonbase. You can match your items to Canonbase items.
A. Step-by-step instructions for adding endpoint to OpenRefine
- Open your project: Open the OpenRefine project containing the data you want to reconcile.
- Select a column: Choose the column header for the data (like names or places) that you want to reconcile against an external service.
- Start the reconciliation process: Click on the drop-down menu for that column.
- Select "Start reconciling": Hover over Reconcile and then select Start reconciling from the menu.
- Add a new service: In the window that appears, click the Add Standard Service button, usually found in the bottom-left corner.
- Input the service URL: A new window will open with a textbox to enter the service's URL. The url is
https://reconcile.purkertlab.cz/en/api , where you may adjust language by replacing language code: i.e. for instance https://reconcile.purkertlab.cz/fr/api for French
- Add the service: Paste the specific reconciliation URL (into the box and click Add Service.
- Use the service: The newly added service will appear in the list, and you can now select it to start matching your data against the remote service.
You do not need to be logged in for it to work.
Detailed description is available at https://openrefine.org/docs/manual/reconciling
B/ uploading data with OpenRefine
for uploading, one has to be logged in to Canonbase in OpenRefine.
Steps to Add a Reconciliation Manifest
- Open the Wikibase Extension Menu: In your OpenRefine project, find the "Wikibase" menu in the top right corner of the window.
- Select "Add Wikibase":
- From the dropdown menu, choose "Select Wikibase instance…" and then click the "Add Wikibase" button.
- Provide the Manifest URL or JSON:
- For a URL: Copy the manifest's URL https://reconcile.purkertlab.cz/static/manifest.json and paste it into the provided field. - Or with below code, copy its content, and paste it into the text box that appears after clicking "Add Wikibase".
The manifest to be pasted: { "version": "2.0", "mediawiki": { "name": "canonbase", "root": "https://canonbase.eu/wiki/", "main_page": "https://canonbase.eu", "api": "https://canonbase.eu/w/api.php" }, "wikibase": { "site_iri": "http://canonbase.eu/entity/", "maxlag": 5, "max_edits_per_minute": 60, "tag": "openrefine home", "properties": { "instance_of": "P11", "subclass_of": "P33" }, "constraints": { "property_constraint_pid": "P2302", "exception_to_constraint_pid": "P2303", "constraint_status_pid": "P2316", "mandatory_constraint_qid": "Q21502408", "suggestion_constraint_qid": "Q62026391", "distinct_values_constraint_qid": "Q21502410" } }, "entity_types": { "item": { "site_iri": "http://canonbase.eu/entity/", "reconciliation_endpoint": "https://reconcile.purkertlab.cz/${lang}/api", "mediawiki_api": "https://canonbase.eu/w/api.php" }, "property": { "site_iri": "http://canonbase.eu/entity/", "mediawiki_api": "https://canonbase.eu/w/api.php" }, "mediainfo": { "site_iri": "http://canonbase.eu/entity/", "reconciliation_endpoint": "https://reconcile.purkertlab.cz/${lang}/api" } } }
- Activate the Service: The new Wikibase instance will appear in the list. Click its name (e.g., "Wikimedia Commons") to select and activate it.
- Close the Dialog: Click the "Close" button to close the dialog window.
The service now should be able to upload, after you are logged in into the Canonbase.