com.ibm.watson.developer_cloud.retrieve_and_rank.v1

Class RetrieveAndRank

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.retrieve_and_rank.v1.RetrieveAndRank

All Implemented Interfaces:

ClusterLifecycleManager, SolrConfigManager

public class RetrieveAndRank
extends WatsonService
implements ClusterLifecycleManager, SolrConfigManager

The IBM Watson Retrieve and Rank service helps users find the most relevant information for their query by using a combination of search and machine learning to find “signals” in the data. Built on top of Apache Solr, developers load their data into the service, train a machine learning model based on known relevant results, then leverage this model to provide improved results to their end users based on their question or query.

Version:

v1

See Also:

Retrieve and Rank

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
RetrieveAndRank() Instantiates a new ranker client.
RetrieveAndRank(String username, String password) Instantiates a new ranker service by username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<Ranker>	createRanker(String name, File training) Sends data to create and train a ranker, and returns information about the new ranker.
ServiceCall<SolrCluster>	createSolrCluster() Creates a new Solr cluster.
ServiceCall<SolrCluster>	createSolrCluster(SolrClusterOptions config) Creates a new Solr cluster, based on the provided configuration.
ServiceCall<Void>	deleteRanker(String rankerID) Deletes a ranker.
ServiceCall<Void>	deleteSolrCluster(String solrClusterId) Deletes an existing Solr Cluster SolrCluster.
ServiceCall<Void>	deleteSolrClusterConfiguration(String solrClusterId, String configName) Deletes a configuration namespace in ZooKeeper.
ServiceCall<Rankers>	getRankers() retrieves the list of rankers for the user.
ServiceCall<Ranker>	getRankerStatus(String rankerID) Retrieves the status of a ranker.
ServiceCall<SolrCluster>	getSolrCluster(String solrClusterId) Returns a Solr cluster information.
ServiceCall<InputStream>	getSolrClusterConfiguration(String solrClusterId, String configName) Gets the configuration from ZooKeeper.
ServiceCall<SolrConfigs>	getSolrClusterConfigurations(String solrClusterId) Lists the configuration sets in ZooKeeper.
ServiceCall<SolrClusterSizeResponse>	getSolrClusterResizeStatus(String solrClusterId) Get the status of a resize request for a cluster.
ServiceCall<SolrClusters>	getSolrClusters() Lists all Solr clusters currently associated with the service instance.
ServiceCall<SolrClusterStats>	getSolrClusterStats(String solrClusterId) Gathers memory and disk usage stats from a Solr cluster.
String	getSolrUrl(String solrClusterId) This URL can be used with the SolrJ library to access Solr functionality.
ServiceCall<Ranking>	rank(String rankerID, File answers, Integer topAnswers) Gets and returns the ranked answers.
ServiceCall<Ranking>	rank(String rankerID, InputStream answers, Integer topAnswers) Gets and returns the ranked answers.
ServiceCall<SolrClusterSizeResponse>	resizeSolrCluster(String solrClusterId, int requestedSize) Change the size of the Solr cluster.
ServiceCall<Void>	uploadSolrClusterConfigurationDirectory(String solrClusterId, String configName, File directory) Uploads a configuration File to ZooKeeper's namespace, including schema.xml, solrconfig.xml, and all other necessary config files to configure a SolrCloud collection.
ServiceCall<Void>	uploadSolrClusterConfigurationZip(String solrClusterId, String configName, File zippedConfig) Uploads a configuration ZIP File to ZooKeeper's namespace, including schema.xml, solrconfig.xml, and all other necessary config files to configure a SolrCloud collection.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RetrieveAndRank

public RetrieveAndRank()

Instantiates a new ranker client.

RetrieveAndRank

public RetrieveAndRank(String username,
                       String password)

Instantiates a new ranker service by username and password.

Parameters:

username - the username

password - the password

Method Detail

createRanker

public ServiceCall<Ranker> createRanker(String name,
                                        File training)

Sends data to create and train a ranker, and returns information about the new ranker. The status has the value of `Training` when the operation is successful, and might remain at this status for a while.

Parameters:

name - Name of the ranker

training - The file with the training data i.e., the set of (qid, feature values, and rank) tuples

Returns:

the ranker object

See Also:

Ranker

createSolrCluster

public ServiceCall<SolrCluster> createSolrCluster()

Description copied from interface: ClusterLifecycleManager

Creates a new Solr cluster.

Specified by:

createSolrCluster in interface ClusterLifecycleManager

Returns:

the Solr cluster

createSolrCluster

public ServiceCall<SolrCluster> createSolrCluster(SolrClusterOptions config)

Description copied from interface: ClusterLifecycleManager

Creates a new Solr cluster, based on the provided configuration.

Specified by:

createSolrCluster in interface ClusterLifecycleManager

Parameters:

config - the solr cluster configuration

Returns:

the Solr cluster

deleteRanker

public ServiceCall<Void> deleteRanker(String rankerID)

Deletes a ranker.

Parameters:

rankerID - the ranker id

Returns:

the service call

deleteSolrCluster

public ServiceCall<Void> deleteSolrCluster(String solrClusterId)

Description copied from interface: ClusterLifecycleManager

Deletes an existing Solr Cluster SolrCluster.
Reports success even if no corresponding cluster actually exists.

Specified by:

deleteSolrCluster in interface ClusterLifecycleManager

Parameters:

solrClusterId - the Solr cluster id

Returns:

the service call

deleteSolrClusterConfiguration

public ServiceCall<Void> deleteSolrClusterConfiguration(String solrClusterId,
                                                        String configName)

Description copied from interface: SolrConfigManager

Deletes a configuration namespace in ZooKeeper.

Specified by:

deleteSolrClusterConfiguration in interface SolrConfigManager

Parameters:

solrClusterId - the solr cluster id

configName - the name of the configuration in ZooKeeper.

Returns:

the service call

getRankers

public ServiceCall<Rankers> getRankers()

retrieves the list of rankers for the user.

Returns:

the rankers

getRankerStatus

public ServiceCall<Ranker> getRankerStatus(String rankerID)

Retrieves the status of a ranker.

Parameters:

rankerID - the ranker ID

Returns:

Ranker object with the status field set

See Also:

Ranker

getSolrCluster

public ServiceCall<SolrCluster> getSolrCluster(String solrClusterId)

Description copied from interface: ClusterLifecycleManager

Returns a Solr cluster information.

Specified by:

getSolrCluster in interface ClusterLifecycleManager

Parameters:

solrClusterId - the Solr cluster id

Returns:

the Solr cluster

getSolrClusterConfiguration

public ServiceCall<InputStream> getSolrClusterConfiguration(String solrClusterId,
                                                            String configName)

Description copied from interface: SolrConfigManager

Gets the configuration from ZooKeeper.

Specified by:

getSolrClusterConfiguration in interface SolrConfigManager

Parameters:

solrClusterId - the solr cluster id

configName - the name of the configuration in ZooKeeper

Returns:

an InputStream containing the zipped configuration if it exists in ZooKeeper or null if it is not found

getSolrClusterConfigurations

public ServiceCall<SolrConfigs> getSolrClusterConfigurations(String solrClusterId)

Description copied from interface: SolrConfigManager

Lists the configuration sets in ZooKeeper.

Specified by:

getSolrClusterConfigurations in interface SolrConfigManager

Parameters:

solrClusterId - the solr cluster id

Returns:

a list of the names of the configuration sets

getSolrClusters

public ServiceCall<SolrClusters> getSolrClusters()

Description copied from interface: ClusterLifecycleManager

Lists all Solr clusters currently associated with the service instance.

Specified by:

getSolrClusters in interface ClusterLifecycleManager

Returns:

the Solr cluster list

getSolrClusterStats

public ServiceCall<SolrClusterStats> getSolrClusterStats(String solrClusterId)

Gathers memory and disk usage stats from a Solr cluster.

Parameters:

solrClusterId - the ID of the Solr cluster to gather stats from

Returns:

stats about the Solr cluster

getSolrUrl

public String getSolrUrl(String solrClusterId)

This URL can be used with the SolrJ library to access Solr functionality.

Parameters:

solrClusterId - the ID of the Solr cluster to connect to

Returns:

URL to access Solr

rank

public ServiceCall<Ranking> rank(String rankerID,
                                 File answers,
                                 Integer topAnswers)

Gets and returns the ranked answers.

Parameters:

rankerID - The ranker ID

answers - The CSV file that contains the search results that you want to rank.

topAnswers - The number of top answers needed, default is 10

Returns:

the ranking of the answers

rank

public ServiceCall<Ranking> rank(String rankerID,
                                 InputStream answers,
                                 Integer topAnswers)

Gets and returns the ranked answers.

Parameters:

rankerID - The ranker ID

answers - The CSV input that contains the search results that you want to rank.

topAnswers - The number of top answers needed, default is 10

Returns:

the ranking of the answers

uploadSolrClusterConfigurationDirectory

public ServiceCall<Void> uploadSolrClusterConfigurationDirectory(String solrClusterId,
                                                                 String configName,
                                                                 File directory)

Description copied from interface: SolrConfigManager

Uploads a configuration File to ZooKeeper's namespace, including schema.xml, solrconfig.xml, and all other necessary config files to configure a SolrCloud collection.

The configuration directory is sent to Solr as a ZIP file. For uploading a ZIP file directly, use SolrConfigManager.uploadSolrClusterConfigurationZip(String, String, File) instead. Config files on the XSLT path will not be uploaded.

Specified by:

uploadSolrClusterConfigurationDirectory in interface SolrConfigManager

Parameters:

solrClusterId - the solr cluster id

configName - the name of the config in ZooKeeper. This name is used when referencing the config when creating a collection.

directory - the directory to upload.

Returns:

the service call

uploadSolrClusterConfigurationZip

public ServiceCall<Void> uploadSolrClusterConfigurationZip(String solrClusterId,
                                                           String configName,
                                                           File zippedConfig)

Description copied from interface: SolrConfigManager

Uploads a configuration ZIP File to ZooKeeper's namespace, including schema.xml, solrconfig.xml, and all other necessary config files to configure a SolrCloud collection.

For uploading a directory, use SolrConfigManager.uploadSolrClusterConfigurationDirectory(String , String, File) instead. Config files on the XSLT path will not be uploaded.

Specified by:

uploadSolrClusterConfigurationZip in interface SolrConfigManager

Parameters:

solrClusterId - the solr cluster id

configName - the name of the config in ZooKeeper. This name is used when referencing the config when creating a collection.

zippedConfig - the ZIP file to upload.

Returns:

the service call

resizeSolrCluster

public ServiceCall<SolrClusterSizeResponse> resizeSolrCluster(String solrClusterId,
                                                              int requestedSize)

Description copied from interface: ClusterLifecycleManager

Change the size of the Solr cluster.

Specified by:

resizeSolrCluster in interface ClusterLifecycleManager

Parameters:

solrClusterId - the solr cluster id

requestedSize - the requested size

Returns:

the status of the resize request

getSolrClusterResizeStatus

public ServiceCall<SolrClusterSizeResponse> getSolrClusterResizeStatus(String solrClusterId)

Description copied from interface: ClusterLifecycleManager

Get the status of a resize request for a cluster.

Specified by:

getSolrClusterResizeStatus in interface ClusterLifecycleManager

Parameters:

solrClusterId - the solr cluster id

Returns:

the status of the resize request