Update the configuration

Updates the configuration.

PUT /2/config

curl

cURL

curl --request PUT \
  --url https://ai-personalization.eu.algolia.com/2/config \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '
{
  "indices": [
    {
      "index": "lorem",
      "affinities": [
        "lorem"
      ],
      "source": {
        "type": "insights",
        "events": {
          "viewDetails": [
            {
              "type": "view",
              "subtype": "addToCart",
              "name": "lorem"
            }
          ],
          "viewListing": [
            {
              "type": "view",
              "subtype": "addToCart",
              "name": "lorem"
            }
          ],
          "addToCart": [
            {
              "type": "view",
              "subtype": "addToCart",
              "name": "lorem"
            }
          ],
          "purchase": [
            {
              "type": "view",
              "subtype": "addToCart",
              "name": "lorem"
            }
          ]
        }
      }
    }
  ],
  "personalizationReRanking": "none",
  "profileType": "basic",
  "features": {
    "realtime": {
      "enabled": true
    }
  }
}
'

200

{
  "errors": [
    {
      "code": "<string>",
      "index": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "status": 123,
  "warnings": [
    {
      "code": "<string>",
      "index": "<string>",
      "message": "<string>"
    }
  ]
}

The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index, create a new configuration object for the index.

Required ACL: search, browse, recommendation

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Body

application/json

features · object · required

Show child attributes

indices · configurationParametersObject · object[] · required

Show child attributes

personalizationReRanking · enum<string> · required

The impact that personalization has on the re-ranking of search results.

Available options: none, low, medium, high, maximum

profileType · enum<string> · required

The type of user profiles to generate.

Basic profiles are based on past behaviors, ensuring search results align with previous interests.

Available options: basic

Response

200

application/json

OK

errors · object[] · required

Show child attributes

message · string · required

status · number · required

warnings · object[] · required

Show child attributes