X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fadministration.xml;h=1dd6a228b9a8b8e31cb67492ba605b2259015e7e;hb=b6ff969813b5ac4c0a6b266979469b0cc24201fd;hp=42e13c1f724e485b8b9dc30eba0efb839582ddc2;hpb=c4e7ef61ea4e05dc00cdaa2b1540986b4e84b505;p=idzebra-moved-to-github.git diff --git a/doc/administration.xml b/doc/administration.xml index 42e13c1..1dd6a22 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,5 +1,5 @@ - + Administrating Zebra - Those are in the zebra config file enabled by a directive like (use - only one of these a time!): + Dynamic ranking is enabled by a directive like one of the + following in the zebra config file (use only one of these a time!): - rank: rank-1 # default - rank: rank-static # dummy - rank: zvrank # TDF-IDF like + rank: rank-1 # default TDF-IDF like + rank: rank-static # dummy do-nothing + rank: zvrank # configurable, experimental TDF-IDF like Notice that the rank-1 and zvrank do not use the static rank information in the list keys, and will produce the same ordering - with our without static ranking enabled. + with or without static ranking enabled. The dummy rank-static reranking/scoring function returns just score = max int - staticrank - in order to preserve the ordering of hit sets with and without it's - call. - Obviously, to combine static and dynamic ranking usefully, one wants + in order to preserve the static ordering of hit sets that would + have been produced had it not been invoked. + Obviously, to combine static and dynamic ranking usefully, + it is necessary to make a new ranking - function, which is left + function; this is left as an exercise for the reader. - + + + + Dynamic ranking is done at query time rather than + indexing time (this is why we + call it ``dynamic ranking'' in the first place ...) + It is invoked by adding + the Bib-1 relation attribute with + value ``relevance'' to the PQF query (that is, + @attr 2=102, see also + + The BIB-1 Attribute Set Semantics). + To find all articles with the word Eoraptor in + the title, and present them relevance ranked, issue the PQF query: + + @attr 2=102 @attr 1=4 Eoraptor + + + + + The default rank-1 ranking module implements a + TF-IDF (Term Frequecy over Inverse Document Frequency) like algorithm. + + + + + Notice that dynamic ranking is not compatible + with estimated hit sizes, as all documents in + a hit set must be acessed to compute the correct placing in a + ranking sorted list. Therefore the use attribute setting + @attr 2=102 clashes with + @attr 9=integer. + + + + + It is possible to apply dynamic ranking on parts of the PQF query + allone: + + Z> f @and @attr 2=102 @attr 1=1010 Utah @attr 1=1018 Springer + + searches for all documents which have the term 'Utah' on the + body of text, and which have the term 'Springer' in the publisher + field, and sort them in the order of the relvance ranking made on + the body of text index only. + + + Rank weight is a way to pass a value to a ranking algorithm - so that + one APT has one value - while another as a different one. For + example, we can + search for 'utah' in use attribute set 'title' with weight 30, as + well as in use attribute set 'any' with weight 20. + + Z> f @attr 2=102 @or @attr 9=30 @attr 1=4 utah @attr 9=20 utah + + + + + The rank weight feature is experimental. It may change in future + releases of zebra, and is not production mature. + + + + + Notice that dynamic ranking can be enabled in + sever side CQL query expansion by adding @attr + 2=102 to the CQL config file. For example + + relationModifier.relevant = 2=102 + + invokes dynamik ranking each time a CQL query of the form + + Z> querytype cql + Z> f alvis.text =/relevant house + + is issued. Dynamic ranking can be enabled on specific CQL indexes + by (for example) setting + + index.alvis.text = 1=text 2=102 + + which then invokes dynamik ranking each time a CQL query of the form + + Z> querytype cql + Z> f alvis.text = house + + is issued. + + + + + + + Sorting + + Sorting is enabled in the configuration of record indexing. For + example, to enable sorting according to the BIB-1 + Date/time-added-to-db field, one could add the line + + xelm /*/@created Date/time-added-to-db:s + + to any .abs record indexing config file, or + similarily, one could add an indexing element of the form + + + + ]]> + to any alvis indexing rule. + + + To trigger a sorting on a pre-defined sorting index of type + s, we can issue a sort with BIB-1 + embedded sort attribute set 7. + The embedded sort is a way to specify sort within a query - thus + removing the need to send a Z39.50 Sort + Request separately. + + + The value after attribute type 7 is + 1 (=ascending), or 2 + (=descending). + The attributes+term (APT) node is separate from the rest of the + PQF query, and must be @or'ed. + The term associated with this attribute is the sorting level, + where + 0 specifies the primary sort key, + 1 the secondary sort key, and so on. + + For example, a search for water, sort by title (ascending), + is expressed by the PQF query + + Z> f @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 + + whereas a search for water, sort by title ascending, + then date descending would be + + Z> f @or @or @attr 1=1016 water @attr 7=1 @attr 1=4 0 @attr 7=2 @attr 1=30 1 + + + + Notice the fundamental differences between dynamic + ranking and sorting: there can only + be one ranking function defined and configured, but there can be + specified multiple sorting indexes dynamically at search + time. Ranking does not need to use specific indexes, which means, + dynamic ranking can be enabled and disabled without + re-indexing. On the other hand, sorting indexes need to be + defined before indexing. + + + + +