Merge pull request #123 from watson-developer-cloud/dev

Merge latest changes from dev

Author: germanattanasio

README.md

@@ -28,6 +28,7 @@ APIs and SDKs that use cognitive computing to solve complex problems.
     * [Natural Language Classifier](#natural-language-classifier)
     * [Personality Insights](#personality-insights)
     * [Relationship Extraction](#relationship-extraction)
+    * [Retrieve and Rank](#retrieve-and-rank)
     * [Speech to Text](#speech-to-text)
     * [Text to Speech](#text-to-speech)
     * [Tone Analyzer](#tone-analyzer)
@@ -52,13 +53,13 @@ Now, you are ready to see some [examples](https://github.com/watson-developer-cl
 <dependency>
 	<groupId>com.ibm.watson.developer_cloud</groupId>
 	<artifactId>java-sdk</artifactId>
-	<version>2.0.0</version>
+	<version>2.1.0</version>
 </dependency>
 ```
 ##### Gradle
 
 ```gradle
-'com.ibm.watson.developer_cloud:java-sdk:2.0.0'
+'com.ibm.watson.developer_cloud:java-sdk:2.1.0'
 ```
 
 ## Usage
@@ -131,14 +132,26 @@ System.out.println(keywords);
 ```
 
 ### Alchemy Data News
-[Alchemy Data News][alchemy_data_news] indexes 250k to 300k English language news and blog articles every day with historical search available for the past 60 days.
-Example: Get the volume data from the last 7 days using 12hs of time slice.
-
+[Alchemy Data News][alchemy_data_news] indexes 250k to 300k English language news and 
+blog articles every day with historical search available for the past 60 days.
+Example: Get 7 documents between Friday 28th August 2015 and Friday 4th September 2015.
+ 
 ```java
 AlchemyDataNews service = new AlchemyDataNews();
 service.setApiKey("<api_key>");
 
-VolumeResult result = service.getVolume("now-7d", "now", "12h");
+Map<String, Object> params = new HashMap<String, Object>();
+
+String[] fields =
+    new String[] {"enriched.url.title", "enriched.url.url", "enriched.url.author",
+        "enriched.url.publicationDate", "enriched.url.enrichedTitle.entities",
+        "enriched.url.enrichedTitle.docSentiment"};
+params.put(AlchemyDataNews.RETURN, StringUtils.join(fields, ","));
+params.put(AlchemyDataNews.START, "1440720000");
+params.put(AlchemyDataNews.END, "1441407600");
+params.put(AlchemyDataNews.COUNT, 7);
+
+DocumentsResult result = service.getNewsDocuments(params);
 
 System.out.println(result);
 ```
@@ -178,7 +191,7 @@ DocumentConversion service = new DocumentConversion();
 service.setUsernameAndPassword("<username>", "<password>");
 
 File doc = new File("src/test/resources/document_conversion/word-document-heading-input.doc");
-Answers htmlToAnswers = service.convertDocumentToAnswer(doc, null);
+Answers htmlToAnswers = service.convertDocumentToAnswer(doc);
 System.out.println(htmlToAnswers);
 ```
 
@@ -257,6 +270,36 @@ String response = service.extract("IBM Watson Developer Cloud");
 System.out.println(response);
 ```
 
+
+### Retrieve and Rank
+The [Retrieve and Rank][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.
+
+
+```java
+RetrieveAndRank service = new RetrieveAndRank();
+service.setUsernameAndPassword("<username>", "<password>");
+
+// 1 create the Solr Cluster
+SolrClusterOptions options = new SolrClusterOptions("my-cluster-name", 1);
+SolrCluster cluster = service.createSolrCluster(options);
+System.out.println("Solr cluster: " + cluster);
+
+// 2 wait until the Solr Cluster is available
+while (cluster.getStatus() == Status.NOT_AVAILABLE) {
+  Thread.sleep(10000); // sleep 10 seconds
+  cluster = service.getSolrCluster(cluster.getId());
+  System.out.println("Solr cluster status: " + cluster.getStatus());
+}
+
+// 3 list Solr Clusters
+System.out.println("Solr clusters: " + service.getSolrClusters());
+```
+
+Retrieve and Rank is built on top of Apache Solr.
+Look at [this](https://github.com/watson-developer-cloud/java-sdk/tree/master/examples/retrieve-and-rank-solrj) example to learn how to use Solrj.
+
 ### Speech to Text
 Use the [Speech to Text][speech_to_text] service to recognize the text from a .wav file.
 
@@ -411,7 +454,7 @@ Gradle:
 
   ```sh
   $ cd java-sdk
-  $ gradle jar  # build jar file (build/libs/watson-developer-cloud-2.0.0.jar)
+  $ gradle jar  # build jar file (build/libs/watson-developer-cloud-2.1.0.jar)
   $ gradle test # run tests
   ```
 
@@ -465,6 +508,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
 [dialog]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/dialog/
 [concept-insights]: https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/concept-insights/
 [visual_insights]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/visual-insights/
+[retrieve_and_rank]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/retrieve-rank/
 
 [alchemy_language]: http://www.alchemyapi.com/products/alchemylanguage
 [sentiment_analysis]: http://www.alchemyapi.com/products/alchemylanguage/sentiment-analysis

build.gradle

@@ -6,7 +6,7 @@ sourceCompatibility = 1.6
 targetCompatibility = 1.6
 group = 'com.ibm.watson.developercloud'
 archivesBaseName = 'watson-developer-cloud'
-version = '2.0.0'
+version = '2.1.0'
 
 description = 'Client library to use the IBM Watson Services and AlchemyAPI'
 

examples/java/com/ibm/watson/developer_cloud/document_conversion/v1/DocumentConversionExample.java

@@ -36,15 +36,15 @@ public static void main(String[] args) throws URISyntaxException, IOException,
         new File("src/test/resources/document_conversion/word-document-heading-input.doc");
 
     System.out.println("Convert html document to Answers");
-    final Answers htmlToAnswers = service.convertDocumentToAnswer(html, null);
+    final Answers htmlToAnswers = service.convertDocumentToAnswer(html);
     System.out.println(htmlToAnswers);
 
     System.out.println("Convert pdf document to Normalized HTML");
-    final String normalizedHTML = service.convertDocumentToHTML(pdf, null);
+    final String normalizedHTML = service.convertDocumentToHTML(pdf);
     System.out.println(normalizedHTML);
 
     System.out.println("Convert html document to Normalized Text");
-    final String normalizedText = service.convertDocumentToText(doc, null);
+    final String normalizedText = service.convertDocumentToText(doc);
     System.out.println(normalizedText);
 
   }

examples/java/com/ibm/watson/developer_cloud/retrieve_and_rank/v1/CreateASolrClusterExample.java

@@ -28,7 +28,7 @@ public static void main(String[] args) throws InterruptedException {
     service.setUsernameAndPassword("<username>", "<password>");
 
     // 2 create the Solr Cluster
-    SolrClusterOptions options = new SolrClusterOptions("<cluster-name>", "1");
+    SolrClusterOptions options = new SolrClusterOptions("<cluster-name>", 1);
     SolrCluster cluster = service.createSolrCluster(options);
     System.out.println("SolrCluster: " + cluster);
 

examples/retrieve-and-rank-solrj/README.md

@@ -0,0 +1,9 @@
+# Retrieve and Rank and Solrj
+
+This example shows how to use the [Retrieve and Rank](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/retrieve-rank.html) service along with the [Solr client in Java (Solrj)](https://wiki.apache.org/solr/Solrj).
+
+## Installation
+
+To run the example you need to install the dependencies
+
+    $ mvn compile

examples/retrieve-and-rank-solrj/pom.xml

@@ -0,0 +1,33 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.ibm.watson.developer_cloud</groupId>
+  <artifactId>retrieve-and-rank-solrj</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+  <packaging>jar</packaging>
+
+  <name>retrieve-and-rank-solrj</name>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <dependencies>
+    <dependency>
+        <groupId>org.apache.solr</groupId>
+        <artifactId>solr-solrj</artifactId>
+        <version>5.2.1</version>
+    </dependency>
+    <dependency>
+        <groupId>org.apache.httpcomponents</groupId>
+        <artifactId>httpclient</artifactId>
+        <version>4.3.6</version>
+    </dependency>
+    <dependency>
+        <groupId>com.ibm.watson.developer_cloud</groupId>
+        <artifactId>java-sdk</artifactId>
+        <version>2.0.0</version>
+    </dependency>
+  </dependencies>
+</project>