-
Notifications
You must be signed in to change notification settings - Fork 223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(recommend): introduce Recommend API client #1280
Conversation
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:
|
Shouldn't we rather use |
algoliarecommend is quite hard to read, don't you think @redox ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good overall, some small questions. Agreed with Sylvain that we need to be 100% sure of the client name before publishing
I think this is not worst than |
@redox Is your reasoning that "specified" clients ready to be used shouldn't be imported with the (I'm fine with both naming.) |
I like the new |
@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? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we just need to add a readme, but ☑️ otherwise!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good call fixing that link!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small question but looks good overall!
911c7db
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wonderful
👏 well done team! |
This adds a new API client for Recommend.
Usage
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