feat(clients): add new realtime-personalization api #4613
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| strategy: | ||
| type: string | ||
| enum: | ||
| - session | ||
| - hybrid | ||
| example: 'session' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,8 @@ | ||||||
| # path | ||||||
| UserToken: | ||||||
| name: userToken | ||||||
| in: path | ||||||
| required: true | ||||||
| description: Unique identifier representing a user for which to fetch the personalization profile. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| schema: | ||||||
| $ref: '../../common/schemas/SearchParams.yml#/userToken' | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| user: | ||
| type: object | ||
| additionalProperties: false | ||
| required: | ||
| - version | ||
| - userID | ||
| - search | ||
| properties: | ||
| version: | ||
| type: string | ||
| description: Version of the response format. | ||
| userID: | ||
| type: string | ||
| description: User ID of the user. | ||
| search: | ||
| type: object | ||
| description: | | ||
| Index personalization filters by index name. | ||
| additionalProperties: | ||
| $ref: '#/searchFilters' | ||
|
|
||
| searchFilters: | ||
| type: object | ||
|
There was a problem hiding this comment. Does this allow us to store search configurations for multiple groups of indices, and have a dynamic name? Example extracted from Francois' presentation: Not sure how we represent that in the spec though. There was a problem hiding this comment. The attribute I'm not fond of this method but we don't have too much choice to respect the response we want. ...
"search": [
{ "aliases": "abc", "strategy": "def", "filters": {...} }
]
...There was a problem hiding this comment. With the current specs the generated exemples looks like this : {
"version": "string",
"userID": "string",
"search": {
"additionalProp1": {
"indices": [
"storefront",
"storefront_price_asc",
"storefront_price_desc"
],
"strategy": "session",
"filters": {
"session": [
"brand:Dyson<score=12>"
],
"additionalProp1": {}
},
"additionalProp1": {}
},
"additionalProp2": {
"indices": [
"storefront",
"storefront_price_asc",
"storefront_price_desc"
],
"strategy": "session",
"filters": {
"session": [
"brand:Dyson<score=12>"
],
"additionalProp1": {}
},
"additionalProp1": {}
},
"additionalProp3": {
"indices": [
"storefront",
"storefront_price_asc",
"storefront_price_desc"
],
"strategy": "session",
"filters": {
"session": [
"brand:Dyson<score=12>"
],
"additionalProp1": {}
},
"additionalProp1": {}
}
},
"additionalProp1": {}
}There was a problem hiding this comment. I believe the reason for this structure was so that the FE could retrieve the required attributes as quick as possible (it's more time consuming to filter an array based on a key than it is to get a specific key from a map). This looks good for now, but if it causes issues we can rethink it |
||
| additionalProperties: false | ||
| properties: | ||
| indices: | ||
| type: array | ||
| items: | ||
| type: string | ||
| example: ['storefront', 'storefront_price_asc', 'storefront_price_desc'] | ||
| strategy: | ||
| $ref: '../enums.yml#/strategy' | ||
| filters: | ||
| $ref: '#/searchFilter' | ||
|
|
||
| searchFilter: | ||
| type: object | ||
| additionalProperties: false | ||
| properties: | ||
| session: | ||
| type: array | ||
| items: | ||
| type: string | ||
| example: ['brand:Dyson<score=12>'] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| get: | ||
| tags: | ||
| - users | ||
| operationId: getUser | ||
| x-acl: | ||
| - recommendation | ||
| summary: Retrieve the user's personalization profile | ||
| description: Retrieves the user's personalization profiles containing search filters. | ||
| parameters: | ||
| - $ref: '../common/parameters.yml#/UserToken' | ||
| responses: | ||
| '200': | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../common/schemas/user.yml#/user' | ||
| '400': | ||
| $ref: '../../common/responses/BadRequest.yml' | ||
| '402': | ||
| $ref: '../../common/responses/FeatureNotEnabled.yml' | ||
| '403': | ||
| $ref: '../../common/responses/MethodNotAllowed.yml' | ||
| '404': | ||
| $ref: '../../common/responses/IndexNotFound.yml' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,43 @@ | ||||||
| openapi: 3.1.0 | ||||||
| info: | ||||||
| title: Realtime Personalization API | ||||||
| description: TODO | ||||||
| version: 0.0.1 | ||||||
| externalDocs: | ||||||
| # TODO: Update the URL | ||||||
| url: https://www.algolia.com/doc/guides/personalization/what-is-personalization/ | ||||||
| description: | | ||||||
| Related guide: Algolia Realtime Personalization. | ||||||
| components: | ||||||
| securitySchemes: | ||||||
| appId: | ||||||
| $ref: '../common/securitySchemes.yml#/appId' | ||||||
| apiKey: | ||||||
| $ref: '../common/securitySchemes.yml#/apiKey' | ||||||
| servers: | ||||||
| - url: https://ai-personalization.{region}.algolia.com | ||||||
benamib marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| variables: | ||||||
| region: | ||||||
| description: | | ||||||
| Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). | ||||||
| enum: [eu, us] | ||||||
| default: eu | ||||||
| security: | ||||||
| - appId: [] | ||||||
| apiKey: [] | ||||||
benamib marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| tags: | ||||||
| - name: users | ||||||
| x-displayName: Users | ||||||
| description: | | ||||||
| User profiles contains the search filters each user has for the different facets in your index. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| x-tagGroups: | ||||||
| - name: General | ||||||
| tags: | ||||||
| - filters | ||||||
| paths: | ||||||
| # ###################### | ||||||
| # ### Custom request ### | ||||||
| # ###################### | ||||||
|
|
||||||
| /2/realtime/users/{userToken}: | ||||||
| $ref: 'paths/getUser.yml' | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 call this
userIDin all the personalization APIs.