TODOS

TODO from Configure Your App Backend and SaaS for Integration

  • write FAQ

    • write about apps, datasets and skin consultant relation

TODO: decide if it is needed. Moved from Integrate Haut.AI Image Analysis with Your App

If you haven't received all results (e.g. received a webhook by timeout)

Not sure if it's a useful block It highly likely means that your image couldn't be processed by one of the algorithms due to internal error and the algorithm can't give any meaningful response as well.

Why can this happen? Maybe the image is too big and the algorithm doesn't have enough memory to process it. Or maybe we have a bug in our code. We constantly monitor all the errors and try to fix them almost immediately, but everything happends.

What can you do in this case?

  1. You can try to fetch results directly from the API.

  2. You can try to reupload the image again, sometimes it helps.

  3. If previous steps didn't help, you can always contact with the support, so we can take a look and help you fix the problem.

TODO: From Visualize Masks on Frontend [JavaScript]

rontend: use canvas to draw masks (ask Frontend team for code snippet). 4 types of mask visualisations, maybe separate them by types here write a doc for each mask type, and then a whole example separate example for flutter integration (kotlin/swift/flutter (dart?)) Backend: use OpenCV and NumPy to draw masks (ask ML team for code snippet).

From SaaS API Overview

Internal notes

Methods from swagger with code snippets, what is required to execute this method correctly (predicates), mention feature flags, what to do if you face an error (maybe more guide related).

Ideally describe all methods from swagger.

Standard usage: see guide and api overview, alternative usage: see api overview.

Ex: signed url is the main upload method - write in guide, multipart and base64 are non-main methods - see API overview (maybe mark deprecated or just optional)

TODO: describe common errors here and specific erros on sub-pages

TODO: how to write API Overview in the fastest way?

  • Company unpaid error?

  • Feature flags enabled/disabled?

  • Not all metrics were calculated

  • Empty webhook data

  • No webhook at all

  • Missing some algorithm from /results/ API

  • result with attr is_ok: False

  • result with result field containing {"error": ... }

  • Application dependencies

TODO:

  1. Add a list of new methods and/or changes (maybe we will send them to customers in a separate letter)

  2. Fix links in new guide (build your own application)

TODO Rewrite API docs marked 🟡

From API for Masks

TODO: add example request

TODO: add example response

TODO: add example image with masks

Internal notes

Methods from swagger with code snippets, what is required to execute this method correctly (predicates), mention feature flags, what to do if you face an error (maybe more guide related).

Ideally describe all methods from swagger.

Standard usage: see guide and api overview, alternative usage: see api overview.

Ex: signed url is the main upload method - write in guide, multipart and base64 are non-main methods - see API overview (maybe mark deprecated or just optional)

TODO: describe common errors here and specific erros on sub-pages

TODO: how to write API Overview in the fastest way?

  • Company unpaid error?

  • Feature flags enabled/disabled?

  • Not all metrics were calculated

  • Empty webhook data

  • No webhook at all

  • Missing some algorithm from /results/ API

  • result with attr is_ok: False

  • result with result field containing {"error": ... }

  • Application dependencies

TODO / Checklist

Copied Roman's comment from JIRA:

Copied Roman's comment from JIRA: Our clients normally need to understand these 4 blocks for each “feature” of the platform:

  1. Shortly, what they can do with object via API. Example for Applications section → What are Applications (here should be link to page in section SaaS Features)? How can I attach / detach application? How can I update settings of application?

  2. More details about logic behind actions Example for Applications section → Can I attach multiple applications? What will happen then? How will it affect my Quota/Price per month?

  3. More details about limitations Example for Applications section → What Applications I MUST always use together (e.g. R.E. will not work without FaceMetrics)? What applications better do not combine?

  4. Good practice examples Example for Applications section → How correctly use Application to receive best results? → NEVER detach Quality algorithm for example

Copied Roman's comment from JIRA:

Our clients usually ask about these details

  1. Detailed (really detailed) explanation of how to use and parse Face Metrics 2.0, including webhooks (prior #1), Hair Metrics (prior #2), Recommendation Engine via API (prior #3)

  2. Detailed explanation of how to use Smoothing API and when to use it

  3. Detailed explanation on how to use PDF reports via API and how to customize these reports inside SaaS UI

  4. More examples on visualise skin masks, especially inside mobile apps (Flutter guide)

Last updated