Comments on: Getting Started with Payloads

By: Grant Ingersoll

Grant Ingersoll — Fri, 18 Jun 2010 15:37:37 +0000

Hi Peter,

Payloads would work fine for that. You will need to use TermPositions to access it or SpanQuery if you want to get the actual payload out at some point other than as part of a search.

By: Peter Wilkins

Peter Wilkins — Fri, 18 Jun 2010 15:03:59 +0000

In your example you use payloads to add metadata to a term. The metadata you add is weight, which is used to change a term’s weight when returned in a search result.

I have a different usecase and I’d like you to comment whether my usecase is consistent with the intended use of the payload feature.

Specifically, I’d like to store a video transcript time-code with each term (the timecode is the number of milliseconds of elapsed time from the start of the video where the term occurs). the timecode is not data that affects Lucene’s indexing or searching behavior, rather it is simply data I want associated with the term.

By: Grant Ingersoll

Grant Ingersoll — Mon, 07 Jun 2010 12:26:26 +0000

Hi Arpit,

Unfortunately, there is no Query Parser support yet, but see https://issues.apache.org/jira/browse/SOLR-1337

By: Arpit

Arpit — Mon, 07 Jun 2010 06:54:05 +0000

Hey, Grant
Its a great article. After reading it, i feel payload can have many applications. But One thing i was not able to figure out, in the article u are using a specific term to query. How can i use it with query parser so that i can search multiple terms.

By: Ajay

Ajay — Mon, 19 Apr 2010 13:23:31 +0000

Thanks Grant I am able to manage getpayload value using TermPosition class but now I am having one issue. I have document with doc_id and Title and I want to get payload for a given term in a given document but current API’s takes input as term only. There is no parameter for document id.
API example:
Term t = new Term(“Title”, “Java”);
TermPositions positions = ir.termPositions(t)

I want to iterate for all documents and wants to get payload for each document separately. Is there any API available ?

By: Grant Ingersoll

Grant Ingersoll — Mon, 19 Apr 2010 00:42:25 +0000

Ajay,

Have a look at the TermPositions class, either that or Span.getPayload()

By: Payload Example for Lucene 3.0.0 : 28

Payload Example for Lucene 3.0.0 : 28 — Sun, 18 Apr 2010 19:23:24 +0000

[...] using BoostTermQuery but I am not able to extract payload value. I am using example mention in http://www.lucidimagination.com/blog/2009/08/05/getting-started-with-payloads/comment-page-1/#commen... Could you please help me to get payload value ? Related Posts:Term offsets for highlighting [...]

By: Ajay

Ajay — Sun, 18 Apr 2010 19:13:52 +0000

Hi Grant,
Thanks for the reply. PayTermQuery works now but I also wants to get some API to get scorepayload value which is currently getting printed in searcher.explain(query, doc.doc) but I want something like getPayLoadValue() which will return payload associated with term.
is there any open API ?

By: Grant Ingersoll

Grant Ingersoll — Sun, 18 Apr 2010 12:35:46 +0000

Ajay,

See http://www.lucidimagination.com/blog/2010/04/18/refresh-getting-started-with-payloads/

I posted an update to this for Lucene 3.0. If you want the same functionality of the BoostingTermQuery, just use the AveragePayloadFunction.

By: Lucid Imagination » Refresh: Getting Started with Payloads

Lucid Imagination » Refresh: Getting Started with Payloads — Sun, 18 Apr 2010 12:34:44 +0000

[...] Lucid Imagination » Getting Started with Payloads, I introduced the basics of payloads, but that article is now slightly out of date if you are using [...]