API for Recommendation Engine Application

The Recommendation Engine application API returns cosmetics products for conditions within three main skincare groups: basic care, eye care, and additional care.

Use this application to get cosmetics recommendations to improve skin conditions based on the results of the skin metrics report. The recommendation engine consists of 41 cosmetics products that address skin concerns within three main groups:

• Basic care

  • Normal skin

  • Aged skin

  • Dry skin

  • Oily skin

• Eye care

  • Eye small wrinkles

  • Eye pronounced wrinkles

  • Eye bags

  • Eye dark circles

• Additional care

  • Anti-aging prevention

  • Anti-aging support therapy

  • Anti-aging complex

  • Acne

  • Pigmentation

  • Vessels

Parameters

Base URL

HTTPS: https://saas.haut.ai/api/v1/companies/{company_id}/datasets/{dataset_id}/subjects/{subject_id}/batches/{batch_id}/images/{image_id}/results/

Supported Methods: GET

Request Parameters

Required Parameters	Description	Type
company_id		string
dataset_id		string
subject_id		string
batch_id		string
image_id		string

Query Parameters

Required Parameters	Description	Type
token		string
application_run_id		string
application_name		string
application_id		string

Example Response (JSON):

 {'id': 'c796f9ae-a44a-4284-ae80-0461ffc7188c',
  'result': {'products': {'spf': ['2_7'],
    'serum': ['16_5', '25_5'],
    'lotion': ['4_6'],
    'cleanser': ['4_2'],
    'eye_care': ['12_12'],
    'day_cream': [],
    'exfoliation': [],
    'night_cream': ['4_4'],
    'make_up_remover': ['4_1']},
   'care_group': {'eye_care': 'Dark circles',
    'basic_care': 'Oily',
    'additional_care': ['Acne', 'Vessels']}},
  'is_ok': True,
  'image_id': 'c20d21ab-f1d7-447c-9c01-b4b753750461',
  'algorithm_version_id': 56,
  'creation_time': '2021-08-02 11:13:12',
  'application_id': '6d9f3fc2-b8d1-4d79-ad65-f751bec04374',
  'application_name': 'Recommendation Engine',
  'application_description': 'This app will recommend solutions to improve the skin’s condition based on the results of the skin metrics report. The app will detect the skin type and provide you with recommendations on basic skin care, eye care and additional care for any particular concerns. The app will also suggest product types, such as serum, day or night cream, cleanser, etc. You can then use this information to recommend skin care cosmetics from your product line.',
  'application_run_id': '92fe3a28-4d6c-41e3-8d9a-9fe45932bbba',
  'image_type': 'selfie',
  'algorithm_family_tech_name': 'selfie_v2.recommendation_engine'}

Field description:

id	Id	string <uuid>
result	algorithm result data	object (Result)
is_ok	algorithm result error status	boolean (Is ok)
image_id	algorithm result image id	string <uuid> (Image id)
algorithm_version_id	algorithm result algo version	integer (Algorithm version id)
creation_time	Creation time	string <date-time>
application_id	Application id	string <uuid>
application_name	Application name	string
application_description	Application description	string
application_run_id	Application run id	string
image_type	Image type	string
algorithm_family_tech_name	Application family technical name	object (AlgorithmFamily)

	name	description	result	result classification
56	Recommendation Engine		str, list	care_group = {basic_care, eye_care, additional_care} products = {serum, eye_care, exfoliation, cleanser, day_cream, night_cream, make_up_remover, spf, lotion}