Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Catalogue match instruments #6

Merged
merged 18 commits into from
Aug 21, 2024
Merged

Catalogue match instruments #6

merged 18 commits into from
Aug 21, 2024

Conversation

zaironjacobs
Copy link
Collaborator

@zaironjacobs zaironjacobs commented Jun 25, 2024

Description

The endpoint text/match will now also return a list of instruments (each instrument containing a list of best instrument matches from the catalogue). Each instrument question also includes the best matched question from the catalogue. A list of best instrument matches from the catalogue is also included for all the instruments.

By default, the catalogue instruments matches will not be included.
To include them, add the following query parameters (optional):
include_catalogue_matches set to true to include the catalogue instrument matches.
catalogue_sources to only return matches from a specific source e.g. MHC etc.

Example:
http://localhost:8000/text/match?include_catalogue_matches=true&catalogue_sources=mhc&catalogue_sources=closer

The catalogue data required for matching will be downloaded from Azure Blob Storage, for this to work include the env variable AZURE_STORAGE_URL (link to where the files are uploaded).

Only the model sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 is currently supported for catalogue matching.

Type of change

  • New feature (non-breaking change which adds functionality)

@woodthom2 woodthom2 merged commit e4a51f0 into main Aug 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants