feat(recommend): introduce Recommend API client

[francoischalifour]

This adds a new API client for Recommend.

Usage

import algoliarecommend from '@algolia/recommend';

const recommendClient = algoliarecommend('appId', 'apiKey');

recommendClient
  .getRelatedProducts({
    /* ... */
  })
  .then((response) => {
    console.log(response);
  });

API

getRelatedProducts

Returns items from the related-products AI model.

getFrequentlyBoughtTogether

Returns items from the bought-together AI model.

getRecommendations

Returns items from the provided AI model (other methods are based on that one).

Next steps

• Add documentation on the Algolia website

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit a42e67c:

Sandbox	Source
javascript-client-app	Configuration

[redox]

const recommendClient = recommend('appId', 'apiKey');

Shouldn't we rather use algoliarecommend like we do for algoliasearch?

[Haroenv]

algoliarecommend is quite hard to read, don't you think @redox ?

[Haroenv]

looks good overall, some small questions. Agreed with Sylvain that we need to be 100% sure of the client name before publishing

[redox]

algoliarecommend is quite hard to read, don't you think @redox ?

I think this is not worst than algoliasearch (we are just less used to it), and I thought we should rather keep consistency here.

[francoischalifour]

@redox Is your reasoning that "specified" clients ready to be used shouldn't be imported with the @algolia npm namespace, but "productized" with algolia*?

(I'm fine with both naming.)

[redox]

@redox Is your reasoning that "specified" clients ready to be used shouldn't be imported with the @algolia npm namespace, but "productized" with algolia*?

(I'm fine with both naming.)

I like the new @algolia/recommend package naming (instead of algoliarecommend or algoliasearch), my point was more about the name of the exported function being recommend VS algoliarecommend. The same way we don't use search but algoliasearch.

[francoischalifour]

@redox Right, the exported function isn't named (it's a default export, users can name it the way they want), so it's just a matter of documentation.

We can document the usage this way:

import algoliarecommend from '@algolia/recommend';

const recommendClient = algoliarecommend('appId', 'apiKey');

Wdyt?

[Haroenv]

we just need to add a readme, but ☑️ otherwise!

[Haroenv]

good call fixing that link!

[shortcuts]

Small question but looks good overall!

[shortcuts]

Wonderful

[redox]

👏 well done team!