Skip to content

Set account to use custom Marqtune model

  1. Construct the Marqtune model name

    In the customer’s console, go to Marqtune and copy the model ID and the checkpoint. The model reference we will use in the ecom index settings will have this structure:

    marqtune/<model ID>/<checkpoint>

    For example:

    marqtune/f5f51064-5678-4be6-851d-8057e56d59cd/epoch_1

    image.png

  2. Follow the steps here for general guidance on editing ecommerce index settings (ensure you have escalator access and it’s under 2PR).

    2.a. You’ll want to update their default configs. Do this by querying the prod-EcomIndexSettingsTable for their system account ID.

    • Note: If you need help getting their system account ID you can query the user accounts table with their customer visible account ID (which you can retrieve from their console if you have access).
      • If you also don’t have access to their customer visible account ID you can use this runbook (more detailed steps, but involves logging into a different AWS account).

    Notice in the screenshot below there are two records: 1) the default configs and 2) the per index configs. We’ll update the default configs.

    image.png

    2.b. make a backup: for the default configs record, save a copy of the settings in case you need to restore, and for sanity checking. It’s recommended to turn off “View DynamoDB JSON” for easier diff viewing

    image.png

    2.c. When changing their settings, ctrl+f for “model”. There should be two entries, one under “ecommerce” settings and one under “fashion” settings. Replace the existing model with the custom model reference you created above. Most of the time it’s advised to replace both “fashion” and “ecommerce” models with the custom model reference.

    image.png

    2.d. if the plan is to delete and recreate a customer’s ecom index (in this example kogan-index ), then:

    2.d.i. be 100% sure it’s not being used in prod, as the next steps will break the index

    2.d.ii. be 100% sure the index you plan to delete is correct and you haven’t messed it up (get your 2PR buddy to double check)

    2.d.iii. be 100% sure the system account ID of the index you plan to delete is correct and you haven’t messed it up (get your 2PR buddy to double check)

    2.d.iv. delete the index (you can just use the console)

    2.d.v. delete the ecom index settings record for that index (if it’s not automatically deleted). if you keep it around it will screw things up when you try to create the index again.

  3. log out of AWS (to stop having write access to prod). Then, revoke your access on escalator

  4. If required, create the index again (with "modelType": "ecommerce" or "modelType": "fashion” - either will use the new custom model if you followed the recommendations in this guide).
    1. Then, test it! Do some test searches (results will likely be empty)
    2. Get the index settings to double check the model being used is the fined model