Word2VecSynonymFilter (Lucene 9.7.0 common API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.TokenFilter
    - - org.apache.lucene.analysis.synonym.word2vec.Word2VecSynonymFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Unwrappable<TokenStream>
```
public final class Word2VecSynonymFilter
extends TokenFilter
```
Applies single-token synonyms from a Word2Vec trained network to an incoming TokenStream.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
  AttributeSource.State

Field Summary
- Fields inherited from class org.apache.lucene.analysis.TokenFilter
  input
- Fields inherited from class org.apache.lucene.analysis.TokenStream
  DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors
Constructor	Description
`Word2VecSynonymFilter(TokenStream input, Word2VecSynonymProvider synonymProvider, int maxSynonymsPerTerm, float minAcceptedSimilarity)`	Apply previously built synonymProvider to incoming tokens.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean incrementToken()

void reset()
- Methods inherited from class org.apache.lucene.analysis.TokenFilter
  close, end, unwrap
- Methods inherited from class org.apache.lucene.util.AttributeSource
  addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Word2VecSynonymFilter
```
public Word2VecSynonymFilter(TokenStream input,
                             Word2VecSynonymProvider synonymProvider,
                             int maxSynonymsPerTerm,
                             float minAcceptedSimilarity)
```
    Apply previously built synonymProvider to incoming tokens.
    
    Parameters:
    
    input - input tokenstream
    
    synonymProvider - synonym provider
    
    maxSynonymsPerTerm - maximum number of result returned by the synonym search
    
    minAcceptedSimilarity - minimal value of cosine similarity between the searched vector and the retrieved ones
- Method Detail
  - incrementToken
```
public boolean incrementToken()
                       throws IOException
```
    Specified by:
    
    incrementToken in class TokenStream
    
    Throws:
    
    IOException
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class TokenFilter
    
    Throws:
    
    IOException