text2sparql-client

Command Line Client to retrieve SPARQL results from a TEXT2SPARQL conform endpoint.

Development

• Run task to see all major development tasks.
• Use pre-commit to avoid errors before commit.
• This repository was created with this copier template.

Usage

The TEXT2SPARQL-CLIENT is the official testing CLI tool for the International TEXT2SPARQL challenge. Tentris-based endpoints are set-up as every graph in its own docker container, using the standard configuration.

CK25

Usage example for the CK25 dataset from the First International TEXT2SPARQL challenge. To execute tests for the CK25 dataset you will need a valid API according to the challenge specifications, see and the directory examples. It contains the questions file questions_ck25.yml the True Result-set ck25_true_result.json (which can be generated with the questions file running the command text2sparql query -o "ck25_true_result.json" questions.yml), and the example shell file. To ask, query and evaluate according to your API open the examples directory and run run_ck25.sh passing <API_URL> <API_NAME>, for example:

cd examples
bash run_ck25.sh "http://localhost:8000" "text2sparql"

DB25

Usage example for the DB25 dataset from the First International TEXT2SPARQL challenge. To execute tests for the CK25 dataset you will need a valid API according to the challenge specifications, see and the directory examples. It contains the questions file questions_db25.yml the True Result-set db25_true_result.json (which can be generated with the questions file running the command text2sparql query -o "db25_true_result.json" questions.yml), and the example shell file. To ask, query and evaluate according to your API open the examples directory and run run_db25.sh passing <API_URL> <API_NAME>, for example:

cd examples
bash run_db25.sh "http://localhost:8000" "text2sparql"

Commands Reference

This portion describes all available CLI commands in the text2sparql-client.

serve

Provide a TEXT2SPARQL testing endpoint. Serves as a simple reference implementation for testing purposes.

Options

Example

text2sparql serve --port 8000 --host 0.0.0.0

ask

Query a TEXT2SPARQL endpoint using a questions YAML file and send each question to the endpoint. Creates a SQLite database to cache responses.

Arguments

Options

Example

text2sparql ask questions.yml http://localhost:8000 -o answers.json

query

Query an RDF endpoint with SPARQL queries from the questions file or answers file. Generates result sets for evaluation purposes.

Arguments

Options

Example

text2sparql query questions.yml -e http://localhost:9080/sparql -o result_set.json

evaluate

Evaluate results from a TEXT2SPARQL endpoint by comparing predicted answers against a ground truth set.

Arguments

Options

Example

text2sparql evaluate my-api true_results.json predicted_results.json -o metrics.json -l "['en', 'es']"

Common Features

Output Options

Ask, query and evaluate support the --output / -o option:

• Specify a file path to save output to a file
• Use - or omit the option to write to stdout
• The command will refuse to overwrite existing files

Language Support

Query and evaluate support multiple languages using the --languages / -l option:

• Provide a Python-style list string: "['en', 'es']"
• Default is English only: ['en']
• Used to generate separate metrics per language in evaluation