Release: v6.2.0

- Added recommend-next-item-segments endpoint support
- Added `searchQuery` parameter support for composite recommendations

Author: MichalDemko

README.md

@@ -13,7 +13,7 @@ The client is available in the [Maven Central Repository](https://mvnrepository.
     <dependency>
         <groupId>com.recombee</groupId>
         <artifactId>api-client</artifactId>
-        <version>6.1.0</version>
+        <version>6.2.0</version>
     </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.recombee</groupId>
     <artifactId>api-client</artifactId>
-    <version>6.1.0</version>
+    <version>6.2.0</version>
     <name>Recombee API Client</name>
     <description>A client library for easy use of the Recombee recommendation API</description>
     <url>https://www.recombee.com</url>

src/main/java/com/recombee/api_client/RecombeeClient.java

@@ -74,6 +74,7 @@
 import com.recombee.api_client.api_requests.RecommendItemSegmentsToUser;
 import com.recombee.api_client.api_requests.RecommendItemSegmentsToItem;
 import com.recombee.api_client.api_requests.RecommendItemSegmentsToItemSegment;
+import com.recombee.api_client.api_requests.RecommendNextItemSegments;
 import com.recombee.api_client.api_requests.CompositeRecommendation;
 import com.recombee.api_client.api_requests.SearchItems;
 import com.recombee.api_client.api_requests.SearchItemSegments;
@@ -98,7 +99,7 @@ public class RecombeeClient {
 
     final int BATCH_MAX_SIZE = 10000; //Maximal number of requests within one batch request
 
-    final String USER_AGENT = "recombee-java-api-client/6.1.0";
+    final String USER_AGENT = "recombee-java-api-client/6.2.0";
 
     private final OkHttpClient httpClient = new OkHttpClient();
 
@@ -444,6 +445,16 @@ public RecommendationResponse send(RecommendItemSegmentsToItemSegment request) t
          return null;
     }
 
+    public RecommendationResponse send(RecommendNextItemSegments request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, RecommendationResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
     public CompositeRecommendationResponse send(CompositeRecommendation request) throws ApiException {
         String responseStr = sendRequest(request);
         try {
@@ -604,7 +615,8 @@ else if ((request instanceof RecommendItemsToUser) ||
                             (request instanceof RecommendItemSegmentsToItem) ||
                             (request instanceof RecommendItemsToItemSegment) ||
                             (request instanceof RecommendItemSegmentsToItemSegment) ||
-                            (request instanceof SearchItemSegments))
+                            (request instanceof SearchItemSegments) ||
+                            (request instanceof RecommendNextItemSegments))
                     {
                         parsedResponse = mapper.convertValue(parsedResponse, RecommendationResponse.class);
                     }

src/main/java/com/recombee/api_client/api_requests/CompositeRecommendation.java

@@ -13,7 +13,7 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.
+ * Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) and a list of related recommendations in a single response.
  * It is ideal for use cases such as personalized homepage sections (*Articles from <category>*), *Because You Watched <movie>*, or *Artists Related to Your Favorite Artist <artist>*.
  * See detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).
  * **Structure**
@@ -63,6 +63,10 @@ public class CompositeRecommendation extends Request {
      * ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
      */
     protected String segmentId;
+    /**
+     * Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+     */
+    protected String searchQuery;
     /**
      * If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
      */
@@ -128,6 +132,14 @@ public CompositeRecommendation setSegmentId(String segmentId) {
          return this;
     }
 
+    /**
+     * @param searchQuery Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+     */
+    public CompositeRecommendation setSearchQuery(String searchQuery) {
+         this.searchQuery = searchQuery;
+         return this;
+    }
+
     /**
      * @param cascadeCreate If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
      */
@@ -184,6 +196,10 @@ public String getSegmentId() {
          return this.segmentId;
     }
 
+    public String getSearchQuery() {
+         return this.searchQuery;
+    }
+
     public boolean getCascadeCreate() {
          if (this.cascadeCreate==null) return false;
          return this.cascadeCreate;
@@ -248,6 +264,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.segmentId!=null) {
             params.put("segmentId", this.segmentId);
         }
+        if (this.searchQuery!=null) {
+            params.put("searchQuery", this.searchQuery);
+        }
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }

src/main/java/com/recombee/api_client/api_requests/RecommendNextItemSegments.java

@@ -0,0 +1,97 @@
+package com.recombee.api_client.api_requests;
+
+/*
+ This file is auto-generated, do not edit
+*/
+
+import java.util.Date;
+import java.util.Map;
+import java.util.HashMap;
+
+import com.recombee.api_client.bindings.Logic;
+import com.recombee.api_client.bindings.CompositeRecommendationStageParameters;
+import com.recombee.api_client.util.HTTPMethod;
+
+/**
+ * Returns Item segments that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to the next page.
+ * It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the number of segments that shall be returned (`count`).
+ * The base request can be one of:
+ *   - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)
+ *   - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)
+ *   - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)
+ *   - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)
+ * All the other parameters are inherited from the base request.
+ * *Recommend next Item segments* can be called many times for a single `recommId` and each call returns different (previously not recommended) segments.
+ * The number of *Recommend next Item segments* calls performed so far is returned in the `numberNextRecommsCalls` field.
+ * *Recommend next Item segments* can be requested up to 30 minutes after the base request or a previous *Recommend next Item segments* call.
+ * For billing purposes, each call to *Recommend next Item segments* is counted as a separate recommendation request.
+ */
+public class RecommendNextItemSegments extends Request {
+
+    /**
+     * ID of the base recommendation request for which next recommendations should be returned
+     */
+    protected String recommId;
+    /**
+     * Number of item segments to be recommended
+     */
+    protected Long count;
+
+    /**
+     * Construct the request
+     * @param recommId ID of the base recommendation request for which next recommendations should be returned
+     * @param count Number of item segments to be recommended
+     */
+    public RecommendNextItemSegments (String recommId,long count) {
+        this.recommId = recommId;
+        this.count = count;
+        this.timeout = 3000;
+    }
+
+
+    public String getRecommId() {
+         return this.recommId;
+    }
+
+    public long getCount() {
+         return this.count;
+    }
+
+    /**
+     * @return Used HTTP method
+     */
+    @Override
+    public HTTPMethod getHTTPMethod() {
+        return HTTPMethod.POST;
+    }
+
+    /**
+     * @return URI to the endpoint including path parameters
+     */
+    @Override
+    public String getPath() {
+        return String.format("/recomms/next/item-segments/%s", this.recommId);
+    }
+
+    /**
+     * Get query parameters
+     * @return Values of query parameters (name of parameter: value of the parameter)
+     */
+    @Override
+    public Map<String, Object> getQueryParameters() {
+        HashMap<String, Object> params = new HashMap<String, Object>();
+        return params;
+    }
+
+    /**
+     * Get body parameters
+     * @return Values of body parameters (name of parameter: value of the parameter)
+     */
+    @Override
+    public Map<String, Object> getBodyParameters() {
+        HashMap<String, Object> params = new HashMap<String, Object>();
+        params.put("count", this.count);
+        return params;
+    }
+
+}

src/test/java/com/recombee/api_client/RecommendNextItemSegmentsBatchTest.java

@@ -0,0 +1,41 @@
+package com.recombee.api_client;
+/*
+ This file is auto-generated, do not edit
+*/
+
+
+import com.recombee.api_client.api_requests.*;
+import com.recombee.api_client.bindings.*;
+import com.recombee.api_client.exceptions.ApiException;
+import com.recombee.api_client.exceptions.ResponseException;
+
+import java.util.HashMap;
+import java.util.Date;
+
+import org.junit.Test;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.fail;
+
+public class RecommendNextItemSegmentsBatchTest extends RecombeeTestCase {
+
+    @Test
+    public void testRecommendNextItemSegments() throws ApiException {
+        Object resp2;
+        try {
+            this.client.send(new RecommendNextItemSegments("invalid_recomm_id",5));
+            fail("No exception thrown");
+        } catch (ResponseException ex) {
+            assertEquals(400,ex.getStatusCode());
+        }
+
+        resp2 = this.client.send(new RecommendItemsToUser("entity_id",3));
+
+        Request[] requests = new Request[] {
+            new RecommendNextItemSegments(((RecommendationResponse)resp2).getRecommId(),5)
+        };
+
+        BatchResponse[] responses = this.client.send(new Batch(requests));
+        assertEquals(400,responses[0].getStatusCode());
+    }
+}

src/test/java/com/recombee/api_client/RecommendNextItemSegmentsTest.java

@@ -0,0 +1,42 @@
+package com.recombee.api_client;
+/*
+ This file is auto-generated, do not edit
+*/
+
+
+import com.recombee.api_client.api_requests.*;
+import com.recombee.api_client.bindings.*;
+import com.recombee.api_client.exceptions.ApiException;
+import com.recombee.api_client.exceptions.ResponseException;
+
+import java.util.HashMap;
+import java.util.Date;
+
+import org.junit.Test;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.fail;
+
+public class RecommendNextItemSegmentsTest extends RecombeeTestCase {
+
+    @Test
+    public void testRecommendNextItemSegments() throws ApiException {
+        RecommendationResponse  resp;
+        Object resp2;
+        // it 'rejects request with invalid recommId'
+        try {
+            this.client.send(new RecommendNextItemSegments("invalid_recomm_id",5));
+            fail("No exception thrown");
+        } catch (ResponseException ex) {
+            assertEquals(400,ex.getStatusCode());
+        }
+        // it 'rejects request to recommId which does not return item-segments'
+        resp2 = this.client.send(new RecommendItemsToUser("entity_id",3));
+        try {
+            this.client.send(new RecommendNextItemSegments(((RecommendationResponse)resp2).getRecommId(),5));
+            fail("No exception thrown");
+        } catch (ResponseException ex) {
+            assertEquals(400,ex.getStatusCode());
+        }
+    }
+}