PQAI Snippet Extraction Service

REST API for extracting passages from full text patent documents, primarily aimed to explain/justify the relevance of a document to a user's search query.

For more detailed information, please refer to PQAI Wiki.

Routes

Method	Endpoint	Comments
GET	/snippet	Return a snippet for given query and document
GET	/mapping	Return mapping against claim elements

How to run?

From command line

1. Clone this repository
2. Download required assets and extract them to /assets directory
3. Create a .env file using /env template and set environment variable values
4. Create a virtual environment and install dependencies: pip install -r requirements.txt
5. Make sure the encoder service and the reranker service is running and properly configured in .env file
6. Run the service: python3 main.py

As docker container

1. Clone this repository
2. Create a .env file using /env template and set environment variable values
3. Give execution permission to the deployment script: chmod +x deploy.sh
4. Run deployment script: bash deploy.sh

License

The project is open-source under the MIT license.

Contribute

We welcome contributions.

To make a contribution, please follow these steps:

1. Fork this repository.
2. Create a new branch with a descriptive name
3. Make the changes you want and add new tests, if needed
4. Make sure all tests are passing
5. Commit your changes
6. Submit a pull request

Support

Please create an issue if you need help.