lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctarg...@apache.org
Subject lucene-solr:jira/solr-10290: SOLR-10296: conversion, letter Q
Date Sun, 07 May 2017 22:19:07 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/jira/solr-10290 53b3eaac6 -> e53c64a35


SOLR-10296: conversion, letter Q


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/e53c64a3
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/e53c64a3
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/e53c64a3

Branch: refs/heads/jira/solr-10290
Commit: e53c64a3508a2a2fd7c01b085d26f39cf89af03e
Parents: 53b3eaa
Author: Cassandra Targett <ctargett@apache.org>
Authored: Sun May 7 17:18:47 2017 -0500
Committer: Cassandra Targett <ctargett@apache.org>
Committed: Sun May 7 17:18:47 2017 -0500

----------------------------------------------------------------------
 solr/solr-ref-guide/src/query-re-ranking.adoc   | 26 ++++++++++----------
 solr/solr-ref-guide/src/query-screen.adoc       | 15 +++++------
 .../src/query-settings-in-solrconfig.adoc       | 10 +++++---
 .../src/query-syntax-and-parsing.adoc           |  2 --
 4 files changed, 25 insertions(+), 28 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e53c64a3/solr/solr-ref-guide/src/query-re-ranking.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/query-re-ranking.adoc b/solr/solr-ref-guide/src/query-re-ranking.adoc
index 61f965a..92efa61 100644
--- a/solr/solr-ref-guide/src/query-re-ranking.adoc
+++ b/solr/solr-ref-guide/src/query-re-ranking.adoc
@@ -3,12 +3,15 @@
 :page-permalink: query-re-ranking.html
 :page-children: learning-to-rank
 
-Query Re-Ranking allows you to run a simple query (A) for matching documents and then re-rank
the top N documents using the scores from a more complex query (B). Since the more costly
ranking from query B is only applied to the top N documents it will have less impact on performance
then just using the complex query B by itself – the trade off is that documents which score
very low using the simple query A may not be considered during the re-ranking phase, even
if they would score very highly using query B.
+Query Re-Ranking allows you to run a simple query (A) for matching documents and then re-rank
the top N documents using the scores from a more complex query (B).
 
-[[QueryRe-Ranking-SpecifyingARankingQuery]]
-== Specifying A Ranking Query
+Since the more costly ranking from query B is only applied to the top _N_ documents it will
have less impact on performance then just using the complex query B by itself. The trade off
is that documents which score very low using the simple query A may not be considered during
the re-ranking phase, even if they would score very highly using query B.
 
-A Ranking query can be specified using the "```rq```" request parameter. The "rq" parameter
must specify a query string that when parsed, produces a {solr-javadocs}/solr-core/org/apache/solr/search/RankQuery.html[RankQuery].
Three rank queries are currently included in the Solr distribution. You can also configure
a custom {solr-javadocs}/solr-core/org/apache/solr/search/QParserPlugin.html[QParserPlugin]
you have written, but most users can just use a parser provided with Solr.
+== Specifying a Ranking Query
+
+A Ranking query can be specified using the `rq` request parameter. The `rq` parameter must
specify a query string that when parsed, produces a {solr-javadocs}/solr-core/org/apache/solr/search/RankQuery.html[RankQuery].
+
+Three rank queries are currently included in the Solr distribution. You can also configure
a custom {solr-javadocs}/solr-core/org/apache/solr/search/QParserPlugin.html[QParserPlugin]
you have written, but most users can just use a parser provided with Solr.
 
 [cols=",",options="header",]
 |===
@@ -18,12 +21,11 @@ A Ranking query can be specified using the "```rq```" request parameter.
The "rq
 |ltr |LTRQParserPlugin
 |===
 
-[[QueryRe-Ranking-ReRankQueryParser]]
 === ReRank Query Parser
 
-The "```rerank```" parser wraps a query specified by an local parameter, along with additional
parameters indicating how many documents should be re-ranked, and how the final scores should
be computed:
+The `rerank` parser wraps a query specified by an local parameter, along with additional
parameters indicating how many documents should be re-ranked, and how the final scores should
be computed:
 
-[width="100%",cols="34%,33%,33%",options="header",]
+[width="100%",options="header",]
 |===
 |Parameter |Default |Description
 |`reRankQuery` |(Mandatory) |The query string for your complex ranking query - in most cases
<<local-parameters-in-queries.adoc#local-parameters-in-queries,a variable>> will
be used to refer to another request parameter.
@@ -33,19 +35,17 @@ The "```rerank```" parser wraps a query specified by an local parameter,
along w
 
 In the example below, the top 1000 documents matching the query "greetings" will be re-ranked
using the query "(hi hello hey hiya)". The resulting scores for each of those 1000 documents
will be 3 times their score from the "(hi hello hey hiya)", plus the score from the original
"greetings" query:
 
-[source,java]
+[source,text]
 ----
 q=greetings&rq={!rerank reRankQuery=$rqq reRankDocs=1000 reRankWeight=3}&rqq=(hi+hello+hey+hiya)
 ----
 
 If a document matches the original query, but does not match the re-ranking query, the document's
original score will remain.
 
-[[QueryRe-Ranking-LTRQueryParser]]
 === LTR Query Parser
 
-The "```ltr```" stands for Learning To Rank, please see <<learning-to-rank.adoc#learning-to-rank,Learning
To Rank>> for more detailed information.
+The `ltr` stands for Learning To Rank, please see <<learning-to-rank.adoc#learning-to-rank,Learning
To Rank>> for more detailed information.
 
-[[QueryRe-Ranking-CombiningRankingQueriesWithOtherSolrFeatures]]
-== Combining Ranking Queries With Other Solr Features
+== Combining Ranking Queries with Other Solr Features
 
-The "```rq```" parameter and the re-ranking feature in general works well with other Solr
features. For example, it can be used in conjunction with the <<collapse-and-expand-results.adoc#collapse-and-expand-results,collapse
parser>> to re-rank the group heads after they've been collapsed. It also preserves
the order of documents elevated by the <<the-query-elevation-component.adoc#the-query-elevation-component,elevation
component>>. And it even has its own custom explain so you can see how the re-ranking
scores were derived when looking at <<common-query-parameters.adoc#CommonQueryParameters-ThedebugParameter,debug
information>>.
+The `rq` parameter and the re-ranking feature in general works well with other Solr features.
For example, it can be used in conjunction with the <<collapse-and-expand-results.adoc#collapse-and-expand-results,collapse
parser>> to re-rank the group heads after they've been collapsed. It also preserves
the order of documents elevated by the <<the-query-elevation-component.adoc#the-query-elevation-component,elevation
component>>. And it even has its own custom explain so you can see how the re-ranking
scores were derived when looking at <<common-query-parameters.adoc#CommonQueryParameters-ThedebugParameter,debug
information>>.

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e53c64a3/solr/solr-ref-guide/src/query-screen.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/query-screen.adoc b/solr/solr-ref-guide/src/query-screen.adoc
index dc84324..347b442 100644
--- a/solr/solr-ref-guide/src/query-screen.adoc
+++ b/solr/solr-ref-guide/src/query-screen.adoc
@@ -2,12 +2,14 @@
 :page-shortname: query-screen
 :page-permalink: query-screen.html
 
-You can use the *Query* screen to submit a search query to a Solr collection and analyze
the results. In the example in the screenshot, a query has been submitted, and the screen
shows the query results sent to the browser as JSON.
+You can use the *Query* screen to submit a search query to a Solr collection and analyze
the results.
 
-image::images/query-screen/query-top.png[image,height=400]
+In the example in the screenshot, a query has been submitted, and the screen shows the query
results sent to the browser as JSON.
 
+.JSON Results of a Query
+image::images/query-screen/query-top.png[image,height=400]
 
-In this example a query for `genre:Fantasy` was sent to a "films" collection. Defaults were
used for all other options in the form, which are explained briefly in the table below, and
covered in detail in later parts of this Guide.
+In this example, a query for `genre:Fantasy` was sent to a "films" collection. Defaults were
used for all other options in the form, which are explained briefly in the table below, and
covered in detail in later parts of this Guide.
 
 The response is shown to the right of the form. Requests to Solr are simply HTTP requests,
and the query submitted is shown in light type above the results; if you click on this it
will open a new browser window with just this request and response (without the rest of the
Solr Admin UI). The rest of the response is shown in JSON, which is part of the request (see
the `wt=json` part at the end).
 
@@ -17,7 +19,7 @@ The `response` includes the documents that matched the query, in `doc` sub-secti
 
 This screen allows you to experiment with different query options, and inspect how your documents
were indexed. The query parameters available on the form are some basic options that most
users want to have available, but there are dozens more available which could be simply added
to the basic request by hand (if opened in a browser). The table below explains the parameters
available:
 
-[width="100%",cols="50%,50%",options="header",]
+[width="100%",options="header",]
 |===
 |Field |Description
 |Request-handler (qt) |Specifies the query handler for the request. If a query handler is
not specified, Solr processes the response with the standard query handler.
@@ -36,8 +38,3 @@ This screen allows you to experiment with different query options, and inspect
h
 |spatial |Click to enable using location data for use in spatial or geospatial searches.
See <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
 |spellcheck |Click this button to enable the Spellchecker, which provides inline query suggestions
based on other, similar, terms. See <<spell-checking.adoc#spell-checking,Spell Checking>>
for more information.
 |===
-
-[[QueryScreen-RelatedTopics]]
-== Related Topics
-
-* <<searching.adoc#searching,Searching>>

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e53c64a3/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc b/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc
index 896c850..52f852d 100644
--- a/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc
@@ -2,7 +2,9 @@
 :page-shortname: query-settings-in-solrconfig
 :page-permalink: query-settings-in-solrconfig.html
 
-The settings in this section affect the way that Solr will process and respond to queries.
These settings are all configured in child elements of the `<query>` element in `solrconfig.xml`.
+The settings in this section affect the way that Solr will process and respond to queries.
+
+These settings are all configured in child elements of the `<query>` element in `solrconfig.xml`.
 
 [source,xml]
 ----
@@ -113,9 +115,7 @@ This sets the maximum number of clauses allowed in a boolean query. This
can aff
 
 [WARNING]
 ====
-
 This option modifies a global property that effects all Solr cores. If multiple `solrconfig.xml`
files disagree on this property, the value at any point in time will be based on the last
Solr core that was initialized.
-
 ====
 
 [[QuerySettingsinSolrConfig-enableLazyFieldLoading]]
@@ -209,7 +209,9 @@ The (commented out) examples below can be found in the `solrconfig.xml`
file of
 
 [IMPORTANT]
 ====
+The above code comes from a _sample_ `solrconfig.xml`.
 
-The above code comes from a _sample_ `solrconfig.xml`. A key best practice is to modify these
defaults before taking your application to production, but please note: while the sample queries
are commented out in the section for the "newSearcher", the sample quer is not commented out
for the "firstSearcher" event. There is no point in auto-warming your Index Searcher with
the query string "static firstSearcher warming in solrconfig.xml" if that is not relevant
to your search application.
+A key best practice is to modify these defaults before taking your application to production,
but please note: while the sample queries are commented out in the section for the "newSearcher",
the sample query is not commented out for the "firstSearcher" event. 
 
+There is no point in auto-warming your Index Searcher with the query string "static firstSearcher
warming in solrconfig.xml" if that is not relevant to your search application.
 ====

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/e53c64a3/solr/solr-ref-guide/src/query-syntax-and-parsing.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/query-syntax-and-parsing.adoc b/solr/solr-ref-guide/src/query-syntax-and-parsing.adoc
index 4bec5e9..31f5131 100644
--- a/solr/solr-ref-guide/src/query-syntax-and-parsing.adoc
+++ b/solr/solr-ref-guide/src/query-syntax-and-parsing.adoc
@@ -15,5 +15,3 @@ The parsers discussed in this Guide are:
 * <<other-parsers.adoc#other-parsers,Other Parsers>>
 
 The query parser plugins are all subclasses of {solr-javadocs}/solr-core/org/apache/solr/search/QParserPlugin.html[QParserPlugin].
If you have custom parsing needs, you may want to extend that class to create your own query
parser.
-
-For more detailed information about the many query parsers available in Solr, see https://wiki.apache.org/solr/SolrQuerySyntax.


Mime
View raw message