Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SOLR-10351: Add documention

This commit is contained in:
Joel Bernstein 2017-06-08 15:18:59 -04:00
parent 40ed09f8ca
commit f631c98677
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
solr/solr-ref-guide/src/stream-evaluators.adoc
View File

@ -36,7 +36,26 @@ can be called on its own or it can be called within the context of a streaming e
== analyze
// TODO
The `analyze` function analyzes text using a Lucene/Solr analyzer and returns a list of tokens
emitted by the analyzer. The `analyze` function can be called on its own or within the
`select` and `cartasianProduct` Streaming Expressions.
=== analyze Parameters
* `Field Name` | `Raw Text`: Either the field in a tuple or the raw text to be analyzed.
* `Analyzer field name`: The field name of the analyzer to use to analyze the text.
=== analyze Syntax
The expressions below show the various ways in which you can use the `analyze` evaluator.
[source,text]
----
analyze("hello world", analyzerField) // Analyze the raw text
select(expr, analyze(textField, analyzerField) as outField) // Analyze a text field within a select expression. This will annotate the tuples with output of the analyzer
cartesianProduct(expr, analyze(textField, analyzer) as outField) // Analyze a text field with a cartesianProduct expression. This will stream each token emitted by the analyzer in its own tuple.
----
== abs