Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
chaoran-chen
left a comment
chaoran-chen
left a comment
There was a problem hiding this comment.
Thanks for the PR! Just a few quick and spontaneous thoughts
| - Use any metadata field as filter (e.g., `country=Ghana`, `date>=2021-01-01`) | ||
| - `nucleotideMutations` - Array of mutations (e.g., `A123T`, `main:G234C`) | ||
| - `aminoAcidMutations` - Array of mutations (e.g., `S:501Y`, `ORF1a:3456K`) |
There was a problem hiding this comment.
Could those examples (and those below) be problematic / misleading for instances that don't have these fields / segments / sequences?
| - Filters and fields are instance-specific based on database configuration | ||
| - Check `/sample/databaseConfig` for full configuration details | ||
| - Check `/sample/referenceGenome` for reference genome structure | ||
| - Some instances may require OAuth authentication (check with unauthenticated request) |
There was a problem hiding this comment.
Would it be better to list all the fields directly in this file? The databaseConfig may not be very clear to understand.
There was a problem hiding this comment.
Have you tried it with different LLMs? I'd be curious to see how they perform. E.g. whether they know how to perform range searches, regexes, use advanced queries etc.
|
As discussed - I incorporated the changes in #1553 |
3 participants
resolves #1544
I've added a
llms.txtthat lists the metadata fields and genes that are used, gives some basic API info and also links to the docs, OpenAPI spec and Swagger.I've decided to template this with Thymeleaf, and also cleaned up the landing page HTML to use templating like that as well. It's a new dependency, but part of the Spring Stack already, so I believe it's not a big deal, and it makes the code much nicer.
I ran this locally, and it worked!
Links in the md file are obviously not clickable, but I used root paths so hopefully an LLM would understand how the links are supposed to work.
PR Checklist
The implemented feature is covered by an appropriate test.