API - sort by relevance

[abe...@utoronto.ca]

Hi,

I'm just going through the documentation and I noticed the API doesn't allow you to sort the results by relevance.

Do you have any plans in making it available in the future?

Thank you.

Abe

[Dan Gillean]

Hi Abe, 

First, this is a browse endpoint, not a search endpoint, so what would the "relevance" criteria be exactly?

More importantly, we would love to expand upon the current API endpoint functionality, but as you may know, we rely on our community for feature development, via development sponsorship and/or community-submitted pull requests. You can read more about our philosophy, business model, and maintenance model for AtoM here: 

• https://wiki.accesstomemory.org/Development/Philosophy 

If your institution is interested in sponsoring API development, please feel free to contact me off-list so we can discuss requirements. Alternatively, if you are interested in extending the API functionality yourself or with local developers, please be sure to review our community Development resources. In terms of submitting a pull request to the public project, be sure to see the Community development recommendations wiki page. 

As an aside - I haven't forgotten about your other question about Elasticsearch. I'm trying to get some developer time to have them respond to you. 

Cheers,  

Dan Gillean, MAS, MLIS
AtoM Program Manager
Artefactual Systems, Inc.
604-527-2056

@accesstomemory

--
You received this message because you are subscribed to the Google Groups "AtoM Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ica-atom-user...@googlegroups.com.
To post to this group, send email to ica-ato...@googlegroups.com.
Visit this group at https://groups.google.com/group/ica-atom-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/ica-atom-users/bbff5969-4fe2-483a-9d8b-28fa83b7d657%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[abe...@utoronto.ca]

Hi Dan,

That's interesting.  I thought the behavior in the API would be more or less like the advanced search since they both use the same set of parameters.

Going back to your question, I guess the "relevance" criteria would be based on the boolean criteria parameters (sq/so/sf), similar to the advanced search form.

I didn't know the API is intended for browsing over searching, because it sounds more like the latter in the documentation.

Thank you for the clarification and looking forward to hear from you about ES.

Abe

On Monday, April 8, 2019 at 11:57:24 AM UTC-4, Dan Gillean wrote:

Hi Abe, 

First, this is a browse endpoint, not a search endpoint, so what would the "relevance" criteria be exactly?

More importantly, we would love to expand upon the current API endpoint functionality, but as you may know, we rely on our community for feature development, via development sponsorship and/or community-submitted pull requests. You can read more about our philosophy, business model, and maintenance model for AtoM here: 

• https://wiki.accesstomemory.org/Development/Philosophy 

If your institution is interested in sponsoring API development, please feel free to contact me off-list so we can discuss requirements. Alternatively, if you are interested in extending the API functionality yourself or with local developers, please be sure to review our community Development resources. In terms of submitting a pull request to the public project, be sure to see the Community development recommendations wiki page. 

As an aside - I haven't forgotten about your other question about Elasticsearch. I'm trying to get some developer time to have them respond to you. 

Cheers,  

Dan Gillean, MAS, MLIS
AtoM Program Manager
Artefactual Systems, Inc.
604-527-2056

@accesstomemory

On Tue, Apr 2, 2019 at 2:56 PM <abe...@utoronto.ca> wrote:

Hi,

I'm just going through the documentation and I noticed the API doesn't allow you to sort the results by relevance.

Do you have any plans in making it available in the future?

Thank you.

Abe

--
You received this message because you are subscribed to the Google Groups "AtoM Users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to ica-ato...@googlegroups.com.

[Dan Gillean]

Hi Abe, 

Ha, it's been a bit since I've looked at the API - you're right, I can see that relevance would be useful. It is called the "browse information objects endpoint," but I see now that it can essentially be used as a search query with the various paremeters that can be passed. My apologies for that!  

Have you tried simply adding it in a query for the sort parameter (e.g. as sort=relevance)? It may actually work  - it could be that we haven't updated the documentation properly. I'll try to find some time to refamiliarize myself with this and test it myself, but if you get a chance, let me know how it goes. 

Dan Gillean, MAS, MLIS
AtoM Program Manager
Artefactual Systems, Inc.
604-527-2056

@accesstomemory

To unsubscribe from this group and stop receiving emails from it, send an email to ica-atom-user...@googlegroups.com.

To post to this group, send email to ica-ato...@googlegroups.com.
Visit this group at https://groups.google.com/group/ica-atom-users.

To view this discussion on the web visit https://groups.google.com/d/msgid/ica-atom-users/2a51d405-ddae-4201-bc4a-8e4c75ec291c%40googlegroups.com.

[abe...@utoronto.ca]

Hi Dan,

No worries.  It's good that we are on the same page.

Yes, I tried that but didn't work unfortunately.  I took a glance at the code and seems like that specific case is missing.

Perhaps your developers could take a look at it and see if it can be done?

Thank you.

Abe

[Dan Gillean]

Hi Abe, 

It can certainly be done, but unfortunately it's a bit more work to figure out than what we can provide via the forum. These other cases are all able to sort on a specific field in the index, but with relevance sorting, we actually need some kind of additional function to calculate the relevance. 

I did find a couple examples that might be used as a reference where relevance is invoked elsewhere - it appears to fetch the Elasticsearch _score and use that for sorting. See for example: 

• https://github.com/artefactual/atom/blob/HEAD/apps/qubit/modules/user/actions/clipboardAction.class.php#L123-L125 
• https://github.com/artefactual/atom/blob/HEAD/apps/qubit/modules/informationobject/actions/browseAction.class.php#L528-L530

We use Elastica as a PHP client for Elasticsearch - I found a function for getScore here: 

• https://github.com/artefactual/atom/blob/HEAD/vendor/elastica/Elastica/Result.php#L117-L120  
  

I don't know if these links will help you figure this out, but if you do, please let us know! 

Dan Gillean, MAS, MLIS
AtoM Program Manager
Artefactual Systems, Inc.
604-527-2056

@accesstomemory

To unsubscribe from this group and stop receiving emails from it, send an email to ica-atom-user...@googlegroups.com.

To post to this group, send email to ica-ato...@googlegroups.com.
Visit this group at https://groups.google.com/group/ica-atom-users.

To view this discussion on the web visit https://groups.google.com/d/msgid/ica-atom-users/5ba28896-2b7e-4e82-ad7f-fb236e6a31ad%40googlegroups.com.