Skip to content
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(neuralsearch): add mode to settings types #1439

Merged
merged 1 commit into from
Mar 2, 2023
Merged

Conversation

cdhawke
Copy link
Contributor

@cdhawke cdhawke commented Feb 28, 2023

Motivation

  • Update the typing to be able to set the mode on a setSettings call.

@cdhawke cdhawke self-assigned this Feb 28, 2023
@codesandbox-ci
Copy link

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 2cb3525:

Sandbox Source
javascript-client-app Configuration

@Haroenv
Copy link
Contributor

Haroenv commented Mar 1, 2023

Is this the final wording? I saw semantic mentioned elsewhere

@cdhawke
Copy link
Contributor Author

cdhawke commented Mar 1, 2023

Is this the final wording? I saw semantic mentioned elsewhere

These are the discussion points for the naming. The settled value is keywordSearch and neuralSearch: https://algolia.atlassian.net/wiki/spaces/NEUR/pages/4414802098/Neuralsearch+API+Design+RFC#Index-Settings
https://algolia.atlassian.net/wiki/spaces/NEUR/pages/4414802098/Neuralsearch+API+Design+RFC#Naming-alternatives-for-the-values-in-the-mode-setting

edit: semanticSearch from what I understand is another top-level object that has yet to be solidified, but will contain the configuration for neuralSearch, when enabled:

{
  "searchableAttributes": [
    "title",
    "description",
    "brand"
  ],
  "semanticSearch": {
    [...]
  },
  "mode": "neuralSearch",
  "customRanking": [
    "desc(retweets)",
    "desc(likes)"
  ]
}

@cdhawke cdhawke requested review from Nagriar and Fluf22 March 1, 2023 13:03
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine by me 🆗

@Haroenv Haroenv removed their request for review March 1, 2023 13:22
Copy link
Contributor

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, but I don't feel comfortable approving/releasing this when naming can still change

@cdhawke
Copy link
Contributor Author

cdhawke commented Mar 1, 2023

looks good, but I don't feel comfortable approving/releasing this when naming can still change

That's fine by me! I added @Nagriar and @Jerska as reviewers to maybe give us some confirmation on the naming when it's settled

Copy link
Member

@Nagriar Nagriar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@cdhawke
Copy link
Contributor Author

cdhawke commented Mar 2, 2023

@Haroenv are you okay if I merge? Is this automatically released or is it manual?

@Haroenv
Copy link
Contributor

Haroenv commented Mar 2, 2023

I'd wait for @shortcuts, I don't think I have credentials to release anymore

Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all goood thanks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants