You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by jb...@apache.org on 2018/09/05 18:17:58 UTC
lucene-solr:branch_7x: SOLR-12701: Fix knnSearch RefGuide
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7x 712aa631b -> 72305b087
SOLR-12701: Fix knnSearch RefGuide
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/72305b08
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/72305b08
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/72305b08
Branch: refs/heads/branch_7x
Commit: 72305b08707d766ea90323170f5c101ba868eaef
Parents: 712aa63
Author: Joel Bernstein <jb...@apache.org>
Authored: Wed Sep 5 14:09:12 2018 -0400
Committer: Joel Bernstein <jb...@apache.org>
Committed: Wed Sep 5 14:17:47 2018 -0400
----------------------------------------------------------------------
.../src/stream-source-reference.adoc | 24 +++++++++-----------
1 file changed, 11 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/72305b08/solr/solr-ref-guide/src/stream-source-reference.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/stream-source-reference.adoc b/solr/solr-ref-guide/src/stream-source-reference.adoc
index 744193e..e9185e0 100644
--- a/solr/solr-ref-guide/src/stream-source-reference.adoc
+++ b/solr/solr-ref-guide/src/stream-source-reference.adoc
@@ -214,36 +214,34 @@ features(collection1,
The `nodes` function provides breadth-first graph traversal. For details, see the section <<graph-traversal.adoc#graph-traversal,Graph Traversal>>.
-== knn
+== knnSearch
-The `knn` function returns the K nearest neighbors for a document based on text similarity. Under the covers the `knn` function
+The `knnSearch` function returns the K nearest neighbors for a document based on text similarity. Under the covers the `knnSearch` function
use the More Like This query parser plugin.
-=== knn Parameters
+=== knnSearch Parameters
* `collection`: (Mandatory) The collection to perform the search in.
* `id`: (Mandatory) The id of the source document to begin the knn search from.
* `qf`: (Mandatory) The query field used to compare documents.
* `k`: (Mandatory) The number of nearest neighbors to return.
* `fl`: (Mandatory) The field list to return.
-* `mintf`: (Optional) The minimum number of occurrences of the term in the source document to be included in the search.
-* `maxtf`: (Optional) The maximum number of occurrences of the term in the source document to be included in the search.
* `mindf`: (Optional) The minimum number of occurrences in the corpus to be included in the search.
* `maxdf`: (Optional) The maximum number of occurrences in the corpus to be included in the search.
* `minwl`: (Optional) The minimum world length of to be included in the search.
* `maxwl`: (Optional) The maximum world length of to be included in the search.
-=== knn Syntax
+=== knnSearch Syntax
[source,text]
----
-knn(collection1,
- id="doc1",
- qf="text_field",
- k="10",
- fl="id, title",
- mintf="3",
- maxdf="10000000")
+knnSearch(collection1,
+ id="doc1",
+ qf="text_field",
+ k="10",
+ fl="id, title",
+ mintf="3",
+ maxdf="10000000")
----
== model