com.attivio.sdk.client

Class MockRelevancyModelApi

java.lang.Object

com.attivio.sdk.client.MockRelevancyModelApi

All Implemented Interfaces:

ExposedApi, RelevancyModelApi

public class MockRelevancyModelApi
extends Object
implements RelevancyModelApi

API for interacting with relevancy models in the system.

Field Summary

Fields inherited from interface com.attivio.sdk.client.RelevancyModelApi

DEFAULT_RELEVANCY_MODEL_NAME, NOOP_RELEVANCY_MODEL_NAME

Constructor Summary

Constructors

Constructor and Description
MockRelevancyModelApi()

Method Summary

Modifier and Type	Method and Description
void	addFeature(RelevancyFeatureDef feature) Add a RelevancyFeatureDef.
long	addRelevancyModel(RelevancyModel model) Create a new relevancy model.
void	deleteFeature(String name) Delete a RelevancyFeatureDef with the specified name.
void	deleteRelevancyModel(String name, long version) Delete a relevancy model.
RelevancyModel	findRelevancyModel(String... query) Find a relevancy model given a query.
RelevancyFeatureDef	getFeature(String name) Get a RelevancyFeatureDef by name.
Iterable<RelevancyFeatureDef>	getFeatures() Get all features.
RelevancyModel	getRelevancyModel(String name, long version) Get a specified version of a relevancy model.
List<String>	getRelevancyModelNames() Returns the names for all available relevancy models.
long	getRelevancyModelPublishTime(String name, long version) Returns the time the specified relevancy model was published.
List<RelevancyModel>	getRelevancyModels(String name) Get all versions available for a relevancy model.
boolean	isFeatureStatic(String name) Returns true if feature is statically defined.
void	publishRelevancyModel(String name, long version) Publish a relevancy model.
static String	resolveKey(String baseName, long version)
void	setRelevancyModels(Iterable<RelevancyModel> value)
void	setRelevancyModels(RelevancyModel... value)
RelevancyModel	testRelevancyModel(RelevancyModel model) Test a relevancy model's accuracy according to stored signal data's expected output.
long	trainRelevancyModel(RelevancyModel model) Train a relevancy model according to signal data as specified by model
void	updateFeature(RelevancyFeatureDef feature) Update a RelevancyFeatureDef.
void	updateRelevancyModel(RelevancyModel model) Update an existing relevancy model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockRelevancyModelApi

public MockRelevancyModelApi()

Method Detail

getRelevancyModelNames

public List<String> getRelevancyModelNames()

Description copied from interface: RelevancyModelApi

Returns the names for all available relevancy models.

Specified by:

getRelevancyModelNames in interface RelevancyModelApi

resolveKey

public static String resolveKey(String baseName,
                                long version)

getRelevancyModel

public RelevancyModel getRelevancyModel(String name,
                                        long version)

Description copied from interface: RelevancyModelApi

Get a specified version of a relevancy model.

Returns null if relevancy model does not exist.

Specified by:

getRelevancyModel in interface RelevancyModelApi

getRelevancyModels

public List<RelevancyModel> getRelevancyModels(String name)

Description copied from interface: RelevancyModelApi

Get all versions available for a relevancy model.

Specified by:

getRelevancyModels in interface RelevancyModelApi

findRelevancyModel

public RelevancyModel findRelevancyModel(String... query)

Description copied from interface: RelevancyModelApi

Find a relevancy model given a query.

Relevancy model names are matched case insensitive.

Returns the first available model specified in query.

Query strings may include a version component in the format modelName#versionNumber to request a specific version. When version is not specified, the relevancy model returned will be the active version for the requested name.

Returns null if no matching relevancy model found.

Specified by:

findRelevancyModel in interface RelevancyModelApi

testRelevancyModel

public RelevancyModel testRelevancyModel(RelevancyModel model)

Description copied from interface: RelevancyModelApi

Test a relevancy model's accuracy according to stored signal data's expected output.

Computing accuracy may take some time, depending on the volume of signal data being used.

NOTE: model does not need to be a saved relevancy model. For instance, you can test the relevancy model prior to adding/updating a model with new weights.

Specified by:

testRelevancyModel in interface RelevancyModelApi

Parameters:

model - A model to evaluate.

Returns:

A model with the accuracy populated according to specified signal data

trainRelevancyModel

public long trainRelevancyModel(RelevancyModel model)

Description copied from interface: RelevancyModelApi

Train a relevancy model according to signal data as specified by model

Returns the version number for the newly created relevancy model.

Relevancy model created will initially have a source of RelevancyModel.Source.TRAINING. Once training of the relevancy model is complete, the source will be updated to be RelevancyModel.Source.TRAINED.

Specified by:

trainRelevancyModel in interface RelevancyModelApi

addRelevancyModel

public long addRelevancyModel(RelevancyModel model)

Description copied from interface: RelevancyModelApi

Create a new relevancy model.

Returns the version number for the newly created relevancy model.

Specified by:

addRelevancyModel in interface RelevancyModelApi

updateRelevancyModel

public void updateRelevancyModel(RelevancyModel model)

Description copied from interface: RelevancyModelApi

Update an existing relevancy model.

Fails if relevancy model does not exist, or if the relevancy model is active.

Specified by:

updateRelevancyModel in interface RelevancyModelApi

deleteRelevancyModel

public void deleteRelevancyModel(String name,
                                 long version)

Description copied from interface: RelevancyModelApi

Delete a relevancy model.

Fails if relevancy model does not exist, if the relevancy model's source is RelevancyModel.Source.STATIC or if the model is active.

Specified by:

deleteRelevancyModel in interface RelevancyModelApi

publishRelevancyModel

public void publishRelevancyModel(String name,
                                  long version)

Description copied from interface: RelevancyModelApi

Publish a relevancy model.

Published relevancy models will be used for matching partial relevancy model names in RelevancyModelApi.getRelevancyModel(String, long).

Fails if relevancy model does not exist.

Specified by:

publishRelevancyModel in interface RelevancyModelApi

getRelevancyModelPublishTime

public long getRelevancyModelPublishTime(String name,
                                         long version)

Description copied from interface: RelevancyModelApi

Returns the time the specified relevancy model was published.

Returns 0 if the relevancy model is not the published model. Returns -1 if the model is the published model, but no time is associated with the publication.

Specified by:

getRelevancyModelPublishTime in interface RelevancyModelApi

getFeatures

public Iterable<RelevancyFeatureDef> getFeatures()

Description copied from interface: RelevancyModelApi

Get all features.

Order of returned features is undefined. Returned features should not be modified in any way.

Specified by:

getFeatures in interface RelevancyModelApi

getFeature

public RelevancyFeatureDef getFeature(String name)

Description copied from interface: RelevancyModelApi

Get a RelevancyFeatureDef by name.

Returns null if feature does not exist.

Specified by:

getFeature in interface RelevancyModelApi

isFeatureStatic

public boolean isFeatureStatic(String name)

Description copied from interface: RelevancyModelApi

Returns true if feature is statically defined.

Statically defined features cannot be updated or deleted.

Specified by:

isFeatureStatic in interface RelevancyModelApi

addFeature

public void addFeature(RelevancyFeatureDef feature)

Description copied from interface: RelevancyModelApi

Add a RelevancyFeatureDef.

Specified by:

addFeature in interface RelevancyModelApi

updateFeature

public void updateFeature(RelevancyFeatureDef feature)

Description copied from interface: RelevancyModelApi

Update a RelevancyFeatureDef.

Specified by:

updateFeature in interface RelevancyModelApi

deleteFeature

public void deleteFeature(String name)

Description copied from interface: RelevancyModelApi

Delete a RelevancyFeatureDef with the specified name.

Specified by:

deleteFeature in interface RelevancyModelApi

setRelevancyModels

public void setRelevancyModels(RelevancyModel... value)

setRelevancyModels

public void setRelevancyModels(Iterable<RelevancyModel> value)