biothings / pending.api

Set of standalone APIs built with the BioThings SDK for the Translator Project
https://biothings.ncats.io
Apache License 2.0
5 stars 10 forks source link

BioThings PFOCR issues #203

Open colleenXu opened 1 month ago

colleenXu commented 1 month ago

Two things I've noticed:

(1) queries like https://biothings.transltr.io/pfocr/query?q=associatedWith.mentions.genes.ncbigene:5879 return no hits even when there are records with that value (example). Maybe it's because there's a misspelling in the metadata/fields entry - which says associatedWith.mentions.genes.bcbigene...

(2) For the PFOCR flavors, I'm not sure how to specify them in the OpenAPI spec / x-bte annotation. They're not regular query-level parameters like fields/size/jmespath/etc....can they be? (see previous Slack convo) @newgene

Refs:

colleenXu commented 3 weeks ago

@newgene @everaldorodrigo I think the first point is easy to fix - and a bug that needs addressing...

I think the second point may need some more discussion

everaldorodrigo commented 3 weeks ago

@colleenXu the first point fix was released to the CI, Test, and Production environments.

everaldorodrigo commented 3 weeks ago

@colleenXu, according to Openapi specs we could modify the endpoint to accept a new parameter called flavor. Ex:

We also could keep both behaviors. The current one and the new one using a parameter called flavor.

What are your thoughts?

newgene commented 3 weeks ago

I would just use flavor=all|strict|synonymous, don't think we need to keep both.

colleenXu commented 3 weeks ago

I think a new parameter like flavor sounds perfect!

everaldorodrigo commented 3 weeks ago

@newgene @colleenXu the flavor=all|strict|synonymous was deployed to the CI environment. The default value for flavor parameter is all

Examples for testing:

colleenXu commented 1 week ago

I have two observations for you/Alex Pico to check on. Otherwise, I think this looks fine and ready to deploy to all instances!

Two observations:

To check behavior, I took a few individual document/records and compared the mention counts. For example, I checked PMC6883319__gr8...

colleenXu commented 1 week ago

And a note to myself: for now, Andrew said I don't need to add this parameter's information to the BioThing API's SmartAPI annotation. We're currently using the default (all).

AlexanderPico commented 4 days ago

It looks like only the gene list differs for the 3 flavors (not chemicals or diseases). Is this correct @AlexanderPico?

Correct

colleenXu commented 4 days ago

@everaldorodrigo @ctrl-schaff @newgene

Your thoughts on my second observation?

newgene commented 3 days ago

order does not matter across different flavor parameter values, as they are different set of hits.

colleenXu commented 3 days ago

So from my perspective, this seems good and ready to deploy to all instances.

colleenXu commented 3 days ago

Let's use the tags to track deployment? Based on the Slack convos, it looks like this is on Test now...