Recombee AddUser icon

Recombee AddUser

Creates a new user in your Recombee database. Users are specified using unique string identifiers that can contain digits, Latin letters, underscores, colons, minus signs, at signs, and dots. This operation is essential for building user profiles and enabling personalized recommendations.

Overview

This node, named "Recombee AddUser," is designed to create new user entries in a Recombee database. Each user is identified by a unique string ID that can include digits, Latin letters, underscores, colons, minus signs, at signs, and dots. Adding users is a fundamental step for building user profiles, which enables personalized recommendations within the Recombee recommendation system.

Typical use cases include:

  • Importing or syncing user data from other systems into Recombee.
  • Creating user profiles dynamically as new users register on a platform.
  • Preparing user data before running recommendation queries tailored to individual users.

Properties

Name Meaning
User ID Unique identifier for the user. Can contain digits, Latin letters, underscores, colons, minus signs, at signs, and dots. This identifies the user in the Recombee database.
Max Retries Number of times to retry failed batch requests. Useful for handling temporary network issues or rate limits. Defaults to 2 retries.

Output

The node outputs an array of JSON objects, each corresponding to one user addition attempt. Each output item contains:

  • success: A boolean indicating whether the user was successfully added.
  • userId: The user ID that was processed.
  • data: The response data from Recombee if the operation succeeded.
  • error: An error message if the operation failed.

If the node is configured to continue on failure, errors for individual user additions are included in the output without stopping the entire execution. Otherwise, the node throws an error immediately upon failure.

No binary data is produced by this node.

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) to communicate with the Recombee service.

Troubleshooting

  • Common Issues:

    • Invalid or missing user IDs may cause errors.
    • Network issues or rate limiting can cause batch requests to fail.
    • Incorrect or expired API credentials will prevent successful communication with Recombee.
  • Error Handling:

    • The node retries batch requests up to the specified "Max Retries" count to handle transient failures.
    • If retries are exhausted, the node either throws an error or continues based on the "Continue On Fail" setting.
    • Error messages returned from Recombee are surfaced in the output for easier debugging.

Links and References

Discussion