RelevancyModel (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.search.relevancy.RelevancyModel

All Implemented Interfaces:

Serializable, Cloneable, Comparable<RelevancyModel>, Iterable<RelevancyModel.FeatureWeight>
```
public class RelevancyModel
extends Object
implements Iterable<RelevancyModel.FeatureWeight>, Comparable<RelevancyModel>, Serializable, Cloneable
```
The model for applying weights and scoring features specified on a QueryRequest.
EXPERIMENTAL: this class is expected to change in incompatible ways.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RelevancyModel.FeatureWeight

static class RelevancyModel.Source

Nested Classes
Modifier and Type	Class and Description
`static class`	`RelevancyModel.FeatureWeight`
`static class`	`RelevancyModel.Source`

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_MAX_HISTORY

static long DEFAULT_MAX_SIGNAL_AGE

static String RELEVANCY_MODEL_WARNING

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_HISTORY`
`static long`	`DEFAULT_MAX_SIGNAL_AGE`
`static String`	`RELEVANCY_MODEL_WARNING`

Constructor Summary

Constructors
Constructor and Description

RelevancyModel()

RelevancyModel(String name)

RelevancyModel(String name, long version)

Constructors
Constructor and Description
`RelevancyModel()`
`RelevancyModel(String name)`
`RelevancyModel(String name, long version)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWeight(String feature, float weight)`
`RelevancyModel`	`clone()`
`int`	`compareTo(RelevancyModel other)`
`boolean`	`equals(Object other)`
`double`	`getAccuracy()` Get the computed accuracy for a trained relevancy model.
`static String`	`getBaseName(String query)` Get the relevancy model name for a query.
`Set<String>`	`getFeatureBlacklist()` Get the names of the features to exclude from relevancy model training data.
`Set<String>`	`getFeatureWhitelist()` Get the names of the features to use for training relevancy model.
`long`	`getLastModified()` Get the timestamp for the last modification to this relevancy model
`int`	`getMaxHistory()` Get the maximum number of trained relevancy models to retain.
`long`	`getMaxSignalAge()` Get maximum age for a signal to include when training relevancy model (in milliseconds).
`String`	`getName()`
`String`	`getOption(String name)` Get an option by name.
`Map<String,String>`	`getOptions()` Get options to use for training relevancy model.
`double`	`getPublishThreshold()` Get the accuracy threshold needed to be achieved to automatically publish a trained relevancy model.
`String`	`getQueryString()` Get a query string for explicitly selecting this relevancy model.
`static String`	`getQueryString(String name, long version)` Get a query string for explicitly selecting this relevancy model.
`Set<String>`	`getSignalTypes()` Get the signal types to use when training relevancy model.
`RelevancyModel.Source`	`getSource()`
`long`	`getVersion()`
`static long`	`getVersion(String query)` Get the version for a relevancy model query.
`List<RelevancyModel.FeatureWeight>`	`getWeights()`
`int`	`hashCode()`
`static boolean`	`isBaseName(String query)` Returns `true` if `query` is a base relevancy model name.
`Iterator<RelevancyModel.FeatureWeight>`	`iterator()`
`void`	`setAccuracy(double value)` Set the computed accuracy for a trained relevancy model.
`void`	`setFeatureBlacklist(Set<String> value)` Set the names of the features to exclude from relevancy model training data.
`void`	`setFeatureBlacklist(String... value)` Set the names of the features to exclude from relevancy model training data.
`void`	`setFeatureWhitelist(Set<String> value)` Set the names of the features to use for training relevancy model.
`void`	`setFeatureWhitelist(String... value)` Set the names of the features to use for training relevancy model.
`void`	`setLastModified(long value)` Get the timestamp for the last modification to this relevancy model
`void`	`setMaxHistory(int value)` Set the maximum number of trained relevancy models to retain.
`void`	`setMaxSignalAge(long value)` Set maximum age for a signal to include when training relevancy model (in milliseconds).
`void`	`setName(String value)`
`void`	`setOption(String name, String value)`
`void`	`setOptions(Map<String,String> value)` Set options to use for training relevancy model.
`void`	`setPublishThreshold(double value)` Set the accuracy threshold needed to be achieved to automatically publish a trained relevancy model.
`void`	`setSignalTypes(Set<String> value)` Set the signal types to use when training relevancy model.
`void`	`setSignalTypes(String... value)`
`void`	`setSource(RelevancyModel.Source value)`
`void`	`setVersion(long value)`
`void`	`setWeights(List<RelevancyModel.FeatureWeight> value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - RELEVANCY_MODEL_WARNING
```
public static final String RELEVANCY_MODEL_WARNING
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_HISTORY
```
public static final int DEFAULT_MAX_HISTORY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_SIGNAL_AGE
```
public static final long DEFAULT_MAX_SIGNAL_AGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RelevancyModel
```
public RelevancyModel()
```
  - RelevancyModel
```
public RelevancyModel(String name)
```
  - RelevancyModel
```
public RelevancyModel(String name,
                      long version)
```
- Method Detail
  - getName
```
public String getName()
```
  - setName
```
public void setName(String value)
```
  - getSource
```
public RelevancyModel.Source getSource()
```
  - setSource
```
public void setSource(RelevancyModel.Source value)
```
  - getVersion
```
public long getVersion()
```
  - setVersion
```
public void setVersion(long value)
```
  - getLastModified
```
public long getLastModified()
```
    Get the timestamp for the last modification to this relevancy model
  - setLastModified
```
public void setLastModified(long value)
```
    Get the timestamp for the last modification to this relevancy model
  - getQueryString
```
public String getQueryString()
```
    Get a query string for explicitly selecting this relevancy model.
  - getAccuracy
```
public double getAccuracy()
```
    Get the computed accuracy for a trained relevancy model.
    Accuracy score will range between 0.0 and 100.0, indicating a percentage score.
    
    Accuracy will only be populated for RelevancyModel.Source.TRAINED relevancy models and will be computed over the signal data used to train the model.
  - setAccuracy
```
public void setAccuracy(double value)
```
    Set the computed accuracy for a trained relevancy model.
    Accuracy score will range between 0.0 and 100.0, indicating a percentage score.
    
    Accuracy will only be populated for RelevancyModel.Source.TRAINED relevancy models and will be computed over the signal data used to train the model.
  - getPublishThreshold
```
public double getPublishThreshold()
```
    Get the accuracy threshold needed to be achieved to automatically publish a trained relevancy model.
    If this threshold is > 0.0 and the computed accuracy for the relevancy model is greater than this threshold, the relevancy model will be automatically published as part of training.
    
    NOTE: only applies when relevancy model is being trained.
  - setPublishThreshold
```
public void setPublishThreshold(double value)
```
    Set the accuracy threshold needed to be achieved to automatically publish a trained relevancy model.
    If this threshold is > 0.0 and the computed accuracy for the relevancy model is greater than this threshold, the relevancy model will be automatically published as part of training.
    
    NOTE: only applies when relevancy model is being trained.
  - getMaxHistory
```
public int getMaxHistory()
```
    Get the maximum number of trained relevancy models to retain.
    If greater than zero, upon successful training of this relevancy model, old trained relevancy models that are not published will be purged.
  - setMaxHistory
```
public void setMaxHistory(int value)
```
    Set the maximum number of trained relevancy models to retain.
    If greater than zero, upon successful training of this relevancy model, old trained relevancy models that are not published will be purged.
  - getMaxSignalAge
```
public long getMaxSignalAge()
```
    Get maximum age for a signal to include when training relevancy model (in milliseconds).
    If less than 1, signals will be included in training data regardless of age.
  - setMaxSignalAge
```
public void setMaxSignalAge(long value)
```
    Set maximum age for a signal to include when training relevancy model (in milliseconds).
    If less than 1, signals will be included in training data regardless of age.
  - getSignalTypes
```
public Set<String> getSignalTypes()
```
    Get the signal types to use when training relevancy model.
    If null all signal types will be included in training data.
  - setSignalTypes
```
public void setSignalTypes(Set<String> value)
```
    Set the signal types to use when training relevancy model.
    If null all signal types will be included in training data.
  - setSignalTypes
```
public void setSignalTypes(String... value)
```
  - getFeatureWhitelist
```
public Set<String> getFeatureWhitelist()
```
    Get the names of the features to use for training relevancy model.
    If null all available features not in getFeatureBlacklist() will be included in training data.
  - setFeatureWhitelist
```
public void setFeatureWhitelist(Set<String> value)
```
    Set the names of the features to use for training relevancy model.
    If no features are specified, all available features not in getFeatureBlacklist() will be included in training data.
  - setFeatureWhitelist
```
public void setFeatureWhitelist(String... value)
```
    Set the names of the features to use for training relevancy model.
    If no features are specified, all available features not in getFeatureBlacklist() will be included in training data.
  - getFeatureBlacklist
```
public Set<String> getFeatureBlacklist()
```
    Get the names of the features to exclude from relevancy model training data.
  - setFeatureBlacklist
```
public void setFeatureBlacklist(Set<String> value)
```
    Set the names of the features to exclude from relevancy model training data.
  - setFeatureBlacklist
```
public void setFeatureBlacklist(String... value)
```
    Set the names of the features to exclude from relevancy model training data.
  - getOption
```
public String getOption(String name)
```
    Get an option by name.
    Options are advanced arbitrary key/value pairs used for tuning the training of relevancy models.
  - setOption
```
public void setOption(String name,
                      String value)
```
  - getOptions
```
public Map<String,String> getOptions()
```
    Get options to use for training relevancy model.
    Options are advanced arbitrary key/value pairs used for tuning the training of relevancy models.
  - setOptions
```
public void setOptions(Map<String,String> value)
```
    Set options to use for training relevancy model.
    Options are advanced arbitrary key/value pairs used for tuning the training of relevancy models.
  - getWeights
```
public List<RelevancyModel.FeatureWeight> getWeights()
```
  - setWeights
```
public void setWeights(List<RelevancyModel.FeatureWeight> value)
```
  - addWeight
```
public void addWeight(String feature,
                      float weight)
```
  - iterator
```
public Iterator<RelevancyModel.FeatureWeight> iterator()
```
    Specified by:
    
    iterator in interface Iterable<RelevancyModel.FeatureWeight>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(RelevancyModel other)
```
    Specified by:
    
    compareTo in interface Comparable<RelevancyModel>
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public RelevancyModel clone()
```
    Overrides:
    
    clone in class Object
  - isBaseName
```
public static boolean isBaseName(String query)
```
    Returns true if query is a base relevancy model name.
    Returns false if query contains a version specification.
  - getBaseName
```
public static String getBaseName(String query)
```
    Get the relevancy model name for a query.
  - getVersion
```
public static long getVersion(String query)
```
    Get the version for a relevancy model query.
  - getQueryString
```
public static String getQueryString(String name,
                                    long version)
```
    Get a query string for explicitly selecting this relevancy model.

Class RelevancyModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

RELEVANCY_MODEL_WARNING

DEFAULT_MAX_HISTORY

DEFAULT_MAX_SIGNAL_AGE

Constructor Detail

RelevancyModel

RelevancyModel

RelevancyModel

Method Detail

getName

setName

getSource

setSource

getVersion

setVersion

getLastModified

setLastModified

getQueryString

getAccuracy

setAccuracy

getPublishThreshold

setPublishThreshold

getMaxHistory

setMaxHistory

getMaxSignalAge

setMaxSignalAge

getSignalTypes

setSignalTypes

setSignalTypes

getFeatureWhitelist

setFeatureWhitelist

setFeatureWhitelist

getFeatureBlacklist

setFeatureBlacklist

setFeatureBlacklist

getOption

setOption

getOptions

setOptions

getWeights

setWeights

addWeight

iterator

hashCode

compareTo

equals

toString

clone

isBaseName

getBaseName

getVersion

getQueryString