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

VERSION

Constructor Summary

Constructors

Constructor and Description
RetrieveAndRank() Instantiates a new ranker client.

Method Summary

Modifier and Type	Method and Description
Ranker	createRanker(String name, File training) Sends data to create and train a ranker, and returns information about the new ranker.
SolrCluster	createSolrCluster() Creates a new Solr cluster.
SolrCluster	createSolrCluster(SolrClusterOptions config) Creates a new Solr cluster, based on the provided configuration.
void	deleteRanker(String rankerID) Deletes a ranker.
void	deleteSolrCluster(String solrClusterId) Deletes an existing Solr Cluster SolrCluster.
void	deleteSolrClusterConfiguration(String solrClusterId, String configName) Deletes a configuration namespace in ZooKeeper.
Rankers	getRankers() retrieves the list of rankers for the user.
Ranker	getRankerStatus(String rankerID) Retrieves the status of a ranker.
SolrCluster	getSolrCluster(String solrClusterId) Returns a Solr cluster information.
InputStream	getSolrClusterConfiguration(String solrClusterId, String configName) Gets the configuration from ZooKeeper.
List<String>	getSolrClusterConfigurations(String solrClusterId) Lists the configuration sets in ZooKeeper.
SolrClusterList	getSolrClusters() Lists all Solr clusters currently associated with the service instance.
String	getSolrUrl(String solrClusterId) This URL can be used with the SolrJ library to access Solr functionality.
Ranking	rank(String rankerID, File answers, Integer topAnswers) Gets and returns the ranked answers.
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.
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, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, 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.

Method Detail

createRanker

public 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 SolrCluster createSolrCluster()

Description copied from interface: ClusterLifecycleManager

Creates a new Solr cluster.

Specified by:

createSolrCluster in interface ClusterLifecycleManager

Returns:

the Solr cluster

createSolrCluster

public 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 void deleteRanker(String rankerID)

Deletes a ranker.

Parameters:

rankerID - the ranker id

deleteSolrCluster

public 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

deleteSolrClusterConfiguration

public 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.

getRankers

public Rankers getRankers()

retrieves the list of rankers for the user.

Returns:

the rankers

getRankerStatus

public 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 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 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 List<String> 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 SolrClusterList 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

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 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

uploadSolrClusterConfigurationDirectory

public 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.

uploadSolrClusterConfigurationZip

public 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.