cambialens / lens-api-doc

10 stars 5 forks source link

Sequence Metadata #68

Closed poldham closed 5 months ago

poldham commented 7 months ago

Hi, I am trying to construct a query using Swagger to obtain information such as sequence counts for records I know have a sequence. However, I am getting a 400 in the response. I'd appreciate any advice on this as all of the sequence related fields documented at https://docs.api.lens.org/request-patent.html#sequence-count seem to return 400.

I am probably missing something but the code below works on just the lens_id but 400s on the sequence.count. Many thanks for any help on this.

{ "query": { "terms": { "ids": ["000-021-670-665-910"] } }, "size": 10, "include": ["lens_id", "sequence.count"] }

AaronBallagh commented 7 months ago

G'day Paul,

I hope you are well! Thanks for this question.

The sequence.count field is a request field only, we have not exposed the sequence metadata fields in the response yet. We will look at adding the sequence metadata fields (not the sequences themselves) to the response and I will let you know when they are available.

Cheers,

Aaron

poldham commented 7 months ago

Hi Aaron,

Thanks for getting back so quickly and I hope you are doing well! Ah, I see. I think the importance of these fields is really for statistical use e.g. trends over time, by species, document section etc to inform policy debates for example under the Biodiversity Convention or the new High Seas Treaty etc. The sequences themselves are not of any interest for that use case.

All the best,

Paul

On 29 Nov 2023, at 04:57, AaronBallagh @.***> wrote:

G'day Paul,

I hope you are well! Thanks for this question.

The sequence.count field is a request field only, we have not exposed the sequence metadata fields in the response yet. We will look at adding the sequence metadata fields (not the sequences themselves) to the response and I will let you know when they are available.

Cheers,

Aaron

— Reply to this email directly, view it on GitHub https://github.com/cambialens/lens-api-doc/issues/68#issuecomment-1831223535, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACTUB4F2DQCG2YRCAIPELPLYG26CBAVCNFSM6AAAAAA75UKNFGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMZRGIZDGNJTGU. You are receiving this because you authored the thread.

AaronBallagh commented 5 months ago

Hi Paul,

I hope you are well!

Just an update, we have added sequence listing metadata fields to the API response now, see https://docs.api.lens.org/response-patent.html#sequence-listing

Cheers,

Aaron