Recombee AddSeries icon

Recombee AddSeries

AddSeries operation from Recombee

Overview

This node integrates with the Recombee recommendation service to add new series entries into a Recombee database. It is designed to batch multiple "AddSeries" requests efficiently, handling retries and error management. This node is useful when you want to programmatically create or update series data in Recombee, for example, when importing a catalog of TV shows, book series, or product collections that need to be recognized as series by the recommendation engine.

Practical scenarios include:

  • Adding new series identifiers to Recombee for personalized recommendations.
  • Bulk uploading series data from an external source.
  • Automatically creating series entries if they do not exist (cascade creation).

Properties

Name Meaning
Series ID The unique identifier of the series to be created in Recombee.
Cascade Create Whether to automatically create the series item if it does not already exist (true/false).
Max Retries Number of times to retry failed batch requests before throwing an error.

Output

The node outputs an array of JSON objects, each representing the result of adding a series. Each output item contains:

  • success: Boolean indicating whether the operation succeeded.
  • seriesId: The ID of the series processed.
  • data: The response data from Recombee for successful operations.
  • error: Error message if the operation failed.

If binary data were involved, it would be summarized here, but this node only outputs JSON results related to the add series operation.

Dependencies

  • Requires an API key credential for authenticating with the Recombee service.
  • Needs configuration of the Recombee database ID, private token, and region via credentials.
  • Uses the official Recombee API client library (recombee-api-client).
  • Supports setting a timeout for API requests (default 10 seconds if unspecified).

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Network timeouts or connectivity problems may cause request failures.
    • Exceeding rate limits or sending malformed series IDs can trigger errors from Recombee.
  • Error messages:
    • Errors returned from Recombee are captured per item; if "Continue On Fail" is disabled, the node stops on first error.
    • Retry logic attempts failed batch requests up to the configured max retries.
  • Resolutions:
    • Verify API credentials and permissions.
    • Increase timeout or max retries if network instability occurs.
    • Ensure series IDs conform to expected formats.

Links and References

Discussion