Difference between revisions of "SMILA/Documentation/Search"
(→SimplePipelets/ProcessingServices in Search pipelines)
|Line 81:||Line 81:|
SearchMessage process(blackboard, SearchMessage message) throws ProcessingException;
where <tt>SearchMessage</tt> consists of a query record ID and a record ID list.
where <tt>SearchMessage</tt> consists of a query record ID and a record ID list.
=== Search Service API ===
=== Search Service API ===
Revision as of 05:30, 4 May 2009
This page describes the search service and related parts of SMILA. This includes the query and result helpers, the processing of search requests in BPEL workflows, and the sample servlet used to create a simple search Web GUI.
- 1 Introduction
- 2 Search Processing
- 3 Search Service API
- 4 Query Parameters
- 5 Query Attribute Annotations
- 6 Result Annotations
- 7 Helper Classes
- 8 Servlet
Let's start at the top: If you have installed SMILA and created an index by starting a crawler you can now use you web browser to go to http://localhost:8080/SMILA/search to search the index:
What happens behind the scenes when you enter a query string and submit the form is that a servlet creates a SMILA record from the HTTP parameters, uses the search service to execute a BPEL workflow on this record, receives an enriched version of the query record and a list of result records in XML form and uses an XSLT stylesheet to create a result HTML page.
Using the Advanced link at the top you can switch to more detailed search page:
This page allows you to enter a more specific query. In case you want to use the default search servlet for your own search page you should use the XSLT files that create these two pages as a reference when trying to design your own search page.
Having seen the tip of the iceberg, we dive down to the very bottom of SMILA search: the actual processing of search requests in SMILA BPEL pipelines. We assume that you are accustomed to the basic SMILA workflow processing features used in indexing workflows. You may want to refer to SMILA/Documentation/BPEL_Workflow_Processor for details.
Search workflows (or pipelines) are very similar to indexing pipelines, but there are a few extensions. The variables in indexing pipelines represent just a simple list of records. This is not sufficient for search pipelines where we need to distinguish between the single record representing the user query (the "query record") and the current list of result records (the "search result"). This results in a few general differences between the BPEL files of indexing and search pipelines:
- the partner link of the pipeline must be of type "proc:SearchProcessorPartnerLinkType":
<partnerLinks> <partnerLink name="Pipeline" partnerLinkType="proc:SearchProcessorPartnerLinkType" myRole="service" /> </partnerLinks>
- the input and output variables of the pipeline itself and of pipelet/service invocations must have the message type "proc:SearchProcessorMessage". This message has only a single part named "records" which can contain a single record (the query record) and a record list (the result records). Refer to org.eclipse.smila.processing.bpel/xml/processor.wsdl for the details of the schema definition.
<variables> <variable name="request" messageType="proc:SearchProcessorMessage" /> </variables>
- The <receive> and <reply> elements must use the portType "proc:SearchProcessorPortType":
<sequence> <receive name="start" partnerLink="Pipeline" portType="proc:SearchProcessorPortType" operation="process" variable="request" createInstance="yes" /> <!-- service/pipelet invocation and other workflow logic --> <reply name="end" partnerLink="Pipeline" portType="proc:SearchProcessorPortType" operation="process" variable="request" /> </sequence>
Apart from this, pipelet/service invocations look the same as in indexing pipelines. See SMILA.application/configuration/org.eclipse.smila.processing.bpel/pipelines/SearchPipeline.bpel for a complete example search pipeline (the one used in the above sample).
SimplePipelets/ProcessingServices in Search pipelines
Recall that the signature of the invocation method of SimplePipelets/ProcessingServices is
Id process(Blackboard blackboard, Id recordIds) throws ProcessingException;
This means when used in search pipelines they cannot process a complete message variable. Therefore the engine selects one part of the message when invoking a "simple" pipeline element:
- if there is not yet a result record list in the message (not even an empty one) the pipelet is called with the query record ID and the output message contains only a single query record ID, too.
- else it is called with the result record list and the result becomes the record list of the output variable. The query record ID is just copied to the result variable.
The rationale behind this is that in a search pipeline first some pipelets may be needed to prepare the query object (enrich the query, set some defaults, etc.), then follows the actual search, which takes the query as input and produces a list of results (thus adds the result record list to the variable) and then additional pipelets may be needed to manipulate the result further. Using the distinction described above makes it possible to use the same pipelet implementation for query and result records, just depending on their position in the pipeline.
For some operations in search pipelines this invocation pattern is not sufficient, the most prominent being the actual search implementation itself: It needs the query record as input and produces a result record list. But there may be other pipelets after the actual search that need to compare query and result records and therefore need access to both kinds of record. To support this, two new interfaces have been defined:
Concerning life cycle and configuration they are identical to standard Simple Pipelets and Processing Services: Pipelets are created and configured by the BPEL engine and must be declared in teh MANIFEST.MF of the providing bundle. ProcessingServices are started independently from the BPEL engine as OSGi services (though for different service interfaces). The enhancement provided by the search pipelets/service is a new invocation method:
SearchMessage process(Blackboard blackboard, SearchMessage message) throws ProcessingException;
where SearchMessage consists of a query record ID and a record ID list.
Search Service API
The actual Search API is quite simple: SMILA registeres an OSGi service with the interface org.eclipse.smila.search.api.SearchService. It provides a few methods that take a SMILA query record and the name of a search workflow as input, execute the workflow on the record and return the result in different formats:
- SearchResult search(String workflowName, Record query) throws ProcessingException: this is the basic method of the search service, that returns the result records as SMILA data structures. The other methods call this method for the actual search execution, too, and just convert the result.
- org.w3c.dom.Document searchAsXml(String workflowName, Record query) throws ProcessingException: return the search result as a XML DOM document. See below for the schema of the result.
- String searchAsXmlString(String workflowName, Record query) throws ProcessingException: return the search result as an XML string. See below for the schema of the result.
The schema of XML search results is basically as follows (target namespace is http://www.eclipse.org/smila/search, see org.eclipse.smila.search.api/xml/search.xsd for the full definition):
<element name="SearchResult"> <complexType> <sequence minOccurs="1" maxOccurs="1"> <element name="Query" minOccurs="1" maxOccurs="1"> <complexType> <sequence> <element name="Workflow" type="string" minOccurs="1" maxOccurs="1" /> <element ref="rec:Record" minOccurs="0" maxOccurs="1" /> </sequence> </complexType> </element> <element ref="rec:RecordList" minOccurs="0" maxOccurs="1"/> </sequence> </complexType> </element>
You can view the result XML by using the sample SMILA search page  and selecting the "Show XML result" checkbox before submitting the query.
The content of the query record basically depends a lot on the used search services. E.g. using the LuceneSearchService, you can set attribute values to search in the index fields to which these attributes have been mapped during indexing (refer to the Lucene integration documentation for details). Other search parameters are attached to the query record as annotations. However, the Search API is also a recommendation where to put some basic, commonly used search parameters, which all index integrations should honor (of course they may quite specify extensions that are not covered by the generic Search API). The following sections describes these recommendations.
Parameters are stored in a single place in the query record and used to describe relatively simple query properties: The query record has a single annotation named "parameters", which can contain:
- single valued parameters: named values of the annotation
- multi valued parameters: subannotation with the parameter name and the values as its anon-values list.
- map valued parameters: subannotations with named values
The Search API defines also the names, allowed values and default values for a set of commonly used parameters. All implementations should use these properties if possible, i.e. they should not introduce additioal parameters for the same purpose, but it may be possible that certain parameters are not supported because it is not feasible with the underlying technology. For some parameters we also define default values. All parameters are single values if not specified differently.
- query: the search string. The index implementor can define a syntax to describe complex search criteria in a single string, SMILA does currently not define an own query syntax. The index implementor might or might not be able to merge this query string with search criteria described by attribute values/annotations of the query record.
- resultSize: number of records to return to the search client, default value is 10.
- resultOffset: number or top results to skip, default value is 0. Use this parameter to implement result list paging: If resultSize=10, the "next page" queries can be identical to the initial query, but with resultOffset=10, 20, ....
- threshold: minimal relevance score that a result must have, default is 0.0.
- language: language of the query, no default value. There could be language specific pipelets/services that need to know in which language the user is expressing his query to work correctly.
- indexName: some index services (like our LuceneIndexService) can manage multiple indexes at once, then they can use this parameter to select the index to search with this request. However, they always should have a default index name configured somehow so that a request succeeds without having this parameter set.
- resultAttributes: multi-valued parameter, describing the names of attributes that should be added to result records by the search engine. This list should only contain the attributes needed by pipelets after the search for processing or by the search page for displaying the results, including too many attributes will always decrease performance. Omitting this parameter should result in getting all available attributes.
- orderBy: map valued parameter with named values "attribute" (any string) and "mode" ("ASC"/"DESC") specifying that the search result should be be sorted by the named attributes in the given direction. Omitting this parameter should result in search result sorted by relevance (score, similarity, ranking, ....). Multiple orderBy annotations can be added and should be evaluated in the order of appearance.
Query Attribute Annotations
Additional annotations can be added to attributes for which they describe refinements of the search. They usually contain only named values and anonymous values.
- Filters: Filters describe hard restrictions on the values of result record attributes that must be matched for a record to be included in a result (in opposite to attribute values which may describe only soft criteria). Advanced search engines might even allow to add multiple filter annotations to a single attribute.
- type: "ENUMERATION"/"RANGE": Specifies if the filter is described by an explicit enumeration of allowed/forbidden values or by giving the lower and/or upper bound. For enumeration filters, the actual filter values are added as anonymous values to the filter annotation. For range filters, see below.
- mode: "ALL"/"ANY"/"ONLY"/"NONE": Specify whether an allowed object must have all, any, only or none of the filter values to match the filter.
- min/max: Specify the lower and/or upper bound of a range filter.
- Ranking: Contains properties that modify the ranking or relevance score of results by manipulating the relevance valuation for a single attribute or for the complete record (if attached to the record itself, not an attribute). Two property names are predefined, but search engine integrations may include additional names:
- name: if the engine knows a number of different named ways or algorithms to compute the relevance this property can be used to select a different one than the default
- boost: changes the weight of this attribute when the local relevance is accumulated into a global one.
Annotations may not only be attached to the query record, but to the records in the search result, too. There are even additional annotations attached to the query object to describe result properties that do not refer to a single result record, but to the complete search result.
- result statistics: After the search the query record contains an annotation named "result" that currently contains these named values
- runtime: runtime for the invoked pipeline, in milliseconds
- totalHits: number of possible results for this query, i.e. all objects from an index that have a relevance score greater than the specified threshold (or zero).
- indexSize: complete number of objects in the searched index.
- Score: Each result record should have a "result" annotation, too, giving at least the ranking score calculated by the search engine as named value "relevance" as a double value (usually 1 means: perfect match).
- Highlighting: TODO
- Facets: TODO
- Terms: TODO
There are some classes that help a client to create query records with their annotations and to read out result records and their annotation. You can find them in package org.eclipse.smila.search.api.helper:
- QueryBuilder: helper class for building queries and sending the query to search service. Returns a result in the form of the next class:
- ResultAccessor: wrapper for the complete search result. Does not do much on its own, but basically creates instances of the following classes to access the records of the result.
- QueryRecordAccessor: Defines methods for accessing literals and annotations of the enriched query that is part of the search result.
- ResultRecordAccessor: Defines methods for reading literals and annotations of search result records.
See the source code or javadocs for more details of the provided methods.
Additionally to this "search backend", SMILA contains a simple servlet that creates a query record from HTTP parameters and displays the result as an HTML page by converting the XML search result using an XSLT stylesheet. This servlet is intended for quick demos, not for productive use. It is usually deployed in the Tomcat instance that comes with SMILA at "/SMILA/search". On first invocation it currently creates a quite empty query record (it sets some default parameters like resultSize etc) and processes it with the default pipeline "SearchPipeline". The pipeline should be able to process such a query and return an empty result list, not an error. The XML representation of this empty result is then transformed using the default stylesheet ("SMILASearchDefault") to present an initial search page.
Note that the servlet actually enriches the XML search result a bit, so the input for the XSLT stylsheet does not completely conform to the defined XML schema. Currently, it adds a section containing the names of indexes available in the LuceneSearchService so that the search page can display the names for selection on the left side:
<SearchResult xmlns="http://www.eclipse.org/smila/search"> <Query> </Query> <RecordList xmlns="http://www.eclipse.org/smila/record"> ... </RecordList> <!-- part added by SearchServlet --> <IndexNames> <IndexName>test_index</IndexName> </IndexNames> </SearchResult>
You can use the same mechanism to add other information to the XML that is necessary to display the search form but not contained in the search service result, you just have to implement your own servlet or extend the default servlet. Please refer to the source code for details.
XSLT Stylehsheets for SMILA search and result pages
The stylesheets are loaded from the configuration directory "org.eclipse.smila.search.servlet" and select using the HTTP parameter "style". The value of this parameter must be the stylesheet filename without suffix, the suffix must bei .xsl. The servlet currently uses the hardcoded default name "SMILASearchDefault" if no other value is set.
In the default application, three stylesheets are avaiable:
- SMILASearchDefault: the default search page. Use this as a reference for how to describe simple queries and to present result lists, including paging through bigger results.
- SMILASearchAdvanced: same layout for the result list, but demostrates how to create more complex query records with attribute values and filters.
- SMILASearchTest: primitive layout, no paging, but demonstrates the setting of even more query features.
To start with another than the default stylesheet, you can add a "style" parameter to the initial URL. E.g., to start with the "advanced" stylesheet, use: http://localhost:8080/SMILA/search?style=SMILASearchAdvanced.
In the following we will describe how to set query record features using the servlet. Please have a look at those sample stylesheets for complete examples of how to apply them, as we will not present something like a full tutorial here (-;
To set a parameter, just use the parameter name as the HTTP parameter name. All values for this HTTP parameter are added to the "parameters" annotation of the query record. E.g., to set the "resultSize" parameter to 7 using an HTML hidden input field, use:
<input type="hidden" name="resultSize" value="7" />
See below for naming rules for the HTTP parameter names to set attribute literals and annotations. Note that you cannot set a parameter with a name that matches one of these rules.
You can add literal string values to attributes using "A.<AttributeName>" as the HTTP parameter name. E.g., to set a value from a HTML text input field as an literal in attribute "Title", use:
<input type="text" name="A.Title" />
Setting other annotations
To set a named value in the ranking annotation for the complete record or an attribute, use "R.<ValueName>[.<AttributeName>]". You are not limited to the predefined ranking value names "name" and "boost". E.g., the following input field sets add a named value "Operator=OR" to attribute "Content":
<input type="hidden" name="R.Operator.Content" value="OR" />
To create a filter for an attribute, use HTTP params:
- "F.<AttributeName>" to set the filter mode ("ALL", "ANY", "ONLY", "NONE")
- "Fval.<AttributeName>" to add filter values to an enumeration filter.
- "Fmin.<AttributeName>" and "Fmax.<AttributeName>" to set the lower/upper bounds of a range filter.
If both "Fval" and "Fmin/Fmax" paramaters are set, the servlet will create both an enumeration filter and a range filter with the same filter mode. It depends on the used search engine integration what happens in this case. E.g.
- to set a filter for attribute "MimeType" restricting the result to HTML documents, use:
<input type="hidden" name="Fval.MimeType" value="text/html" />
- to set a filter for attribute "FileSize" restricting the result to document sizes between 1000 and 10000 bytes, use:
<input type="hidden" name="Fmin.FileSize" value="1000" /> <input type="hidden" name="Fmax.FileSize" value="10000" />
To set named values in other attribute annotations, use "A.<AttributeName>.(<AnnotationName>.)+<ValueName>". Note that this does not work for attribute and annotation names containing "." characters. E.g., the following snippet create an annotation "highlight" on attribute "Concent", with a sub-annotation "HighlightingTransformer" and a named value "name=Sentence":
<input type="hidden" name="A.Content.highlight.HighlightingTransformer.name" value="Sentence" />