Class AnalyzeDescriptor
Inheritance
AnalyzeDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class AnalyzeDescriptor : RequestDescriptorBase<AnalyzeDescriptor, AnalyzeRequestParameters, IAnalyzeRequest>, IDescriptor, IAnalyzeRequest, IRequest<AnalyzeRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
AnalyzeDescriptor()
Declaration
public AnalyzeDescriptor()
|
Edit this page
View Source
AnalyzeDescriptor(IndexName)
Declaration
public AnalyzeDescriptor(IndexName index)
Parameters
Type |
Name |
Description |
IndexName |
index |
Optional, accepts null
|
Methods
|
Edit this page
View Source
Analyzer(string)
The name of the analyzer to use
Declaration
public AnalyzeDescriptor Analyzer(string analyser)
Parameters
Type |
Name |
Description |
string |
analyser |
|
Returns
|
Edit this page
View Source
Attributes(IEnumerable<string>)
Filter only certain token attributes to be returned
Declaration
public AnalyzeDescriptor Attributes(IEnumerable<string> attributes)
Parameters
Returns
|
Edit this page
View Source
Attributes(params string[])
Filter only certain token attributes to be returned
Declaration
public AnalyzeDescriptor Attributes(params string[] attributes)
Parameters
Type |
Name |
Description |
string[] |
attributes |
|
Returns
|
Edit this page
View Source
CharFilter(IEnumerable<string>)
A collection of character filters to use for the analysis
Declaration
public AnalyzeDescriptor CharFilter(IEnumerable<string> charFilter)
Parameters
Returns
|
Edit this page
View Source
CharFilter(Func<AnalyzeCharFiltersDescriptor, IPromise<AnalyzeCharFilters>>)
A collection of character filters to use for the analysis
Declaration
public AnalyzeDescriptor CharFilter(Func<AnalyzeCharFiltersDescriptor, IPromise<AnalyzeCharFilters>> charFilters)
Parameters
Returns
|
Edit this page
View Source
CharFilter(params string[])
A collection of character filters to use for the analysis
Declaration
public AnalyzeDescriptor CharFilter(params string[] charFilter)
Parameters
Type |
Name |
Description |
string[] |
charFilter |
|
Returns
|
Edit this page
View Source
Explain(bool?)
Return more details, and output the analyzer chain per step in the process
Declaration
public AnalyzeDescriptor Explain(bool? explain = true)
Parameters
Type |
Name |
Description |
bool? |
explain |
|
Returns
|
Edit this page
View Source
Field(Field)
Use the analyzer configured for this field (instead of passing the analyzer name)
Declaration
public AnalyzeDescriptor Field(Field field)
Parameters
Type |
Name |
Description |
Field |
field |
|
Returns
|
Edit this page
View Source
Field<T>(Expression<Func<T, object>>)
Use the analyzer configured for this field (instead of passing the analyzer name)
Declaration
public AnalyzeDescriptor Field<T>(Expression<Func<T, object>> field)
Parameters
Returns
Type Parameters
|
Edit this page
View Source
Field<T, TValue>(Expression<Func<T, TValue>>)
Use the analyzer configured for this field (instead of passing the analyzer name)
Declaration
public AnalyzeDescriptor Field<T, TValue>(Expression<Func<T, TValue>> field)
Parameters
Returns
Type Parameters
Name |
Description |
T |
|
TValue |
|
|
Edit this page
View Source
Filter(IEnumerable<string>)
A collection of filters to use for the analysis
Declaration
public AnalyzeDescriptor Filter(IEnumerable<string> filter)
Parameters
Returns
|
Edit this page
View Source
Filter(Func<AnalyzeTokenFiltersDescriptor, IPromise<AnalyzeTokenFilters>>)
A collection of filters to use for the analysis
Declaration
public AnalyzeDescriptor Filter(Func<AnalyzeTokenFiltersDescriptor, IPromise<AnalyzeTokenFilters>> tokenFilters)
Parameters
Returns
|
Edit this page
View Source
Filter(params string[])
A collection of filters to use for the analysis
Declaration
public AnalyzeDescriptor Filter(params string[] filter)
Parameters
Type |
Name |
Description |
string[] |
filter |
|
Returns
|
Edit this page
View Source
Index(IndexName)
The name of the index to scope the operation
Declaration
public AnalyzeDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public AnalyzeDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Normalizer(string)
The name of the normalizer to use
Declaration
public AnalyzeDescriptor Normalizer(string normalizer)
Parameters
Type |
Name |
Description |
string |
normalizer |
|
Returns
|
Edit this page
View Source
Text(IEnumerable<string>)
The text on which the analysis should be performed
Declaration
public AnalyzeDescriptor Text(IEnumerable<string> text)
Parameters
Returns
|
Edit this page
View Source
Text(params string[])
The text on which the analysis should be performed
Declaration
public AnalyzeDescriptor Text(params string[] text)
Parameters
Type |
Name |
Description |
string[] |
text |
|
Returns
|
Edit this page
View Source
An inline definition of a tokenizer
Declaration
public AnalyzeDescriptor Tokenizer(Func<AnalyzeTokenizersSelector, ITokenizer> tokenizer)
Parameters
Returns
|
Edit this page
View Source
Tokenizer(string)
The name of the tokenizer to use for the analysis
Declaration
public AnalyzeDescriptor Tokenizer(string tokenizer)
Parameters
Type |
Name |
Description |
string |
tokenizer |
|
Returns
Implements
Extension Methods