Exposing a lookup in a dataset

The “dataset(s) lookup” endpoint offers an API for searching records in a DSS dataset by looking it up using lookup keys.

For example, if you have a “customers” dataset in DSS, you can expose a “dataset lookup” endpoint where you can pass in the email address and retrieve other columns from the matching customer.

A “dataset lookup” endpoint can:

  • lookup in multiple datasets at once
  • lookup multiple input records at once
  • lookup based on multiple lookup keys
  • retrieve arbitrary number of columns

However, note that each lookup can not return more than one dataset line for each input lookup records. Multiple results either generate an error or get dropped.

Note

The “dataset lookup” endpoint is very similar to the feature to enrich prediction queries before passing them to a prediction model.

In essence the “Dataset lookup” enpdoint is only the “Enrich” part of prediction endpoints

Creating the lookup endpoint

To create a custom prediction endpoint, start by creating a service. (See Your first API service for more information). Then, create an endpoint of type “Dataset lookup”

Configuration and deployment

Configuration, deployment options and specificities are the same as for the feature to enrich prediction queries before passing them to a prediction model.