aexol-studio/newsletter_samarite

Recommendation System for samarite (newsletter)

Public

77 runs

Run with an API

Pricing

Playground API Examples README Versions

Run aexol-studio/newsletter_samarite with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
url	string		Samarite API URL
login	string		Samarite API Login
password	string		Samarite API Password
num_last_orders	integer	0	Number of last orders to retrieve, more than 10000 and less than 200000
start_date	string		Start date for the data retrieval e.g. 2024-01-01T07:25:18.724Z
end_date	string		End date for the data retrieval e.g. 2024-03-01T07:25:18.724Z (the period should be at least one week)
product	None		Product name
custom_product	string		Custom product name
predict_type	None	rfm-score	Prediction type
show_metrics	boolean	False	Whether to show the evaluation metrics

{
  "type": "object",
  "title": "Input",
  "required": [
    "url",
    "login",
    "password"
  ],
  "properties": {
    "url": {
      "type": "string",
      "title": "Url",
      "format": "password",
      "x-order": 0,
      "description": "Samarite API URL",
      "x-cog-secret": true
    },
    "login": {
      "type": "string",
      "title": "Login",
      "format": "password",
      "x-order": 1,
      "description": "Samarite API Login",
      "x-cog-secret": true
    },
    "product": {
      "enum": [
        "GRAND DIVINE CREAM",
        "PREZENT",
        "ZESTAW BALANCE",
        "BUSY MOM SET",
        "PREZENT DLA MAMY",
        "MINI DIVINE ELIXIR",
        "KARTKA ''W DNIU TWOJEGO \u015aWI\u0118TA\"",
        "HERBUS KREM DO R\u0104K",
        "ZESTAW DO ZADA\u0143 SPECJALNYCH",
        "MINI SUPREME CLEANSER",
        "DIVINE ACID PEELING&MASK",
        "TORBA PAPIEROWA ORIGINAL",
        "SUPREME BALM",
        "ALL OVER MIST",
        "SET DIVINE ACID PEELING & DIVINE CREAM",
        "Prezent dla Mamy",
        "SET DIVINE SKIN PERFECTOR SPF 50",
        "ZESTAW M\u0141ODO\u015aCI",
        "ZESTAW DLA NIEGO",
        "DIVINE SKIN PERFECTOR SPF 50",
        "DIVINE ELIXIR ",
        "ZESTAW REGENERACJI",
        "MINI SUPREME SET",
        "MINI SUPREME BALM",
        "CUSTOM",
        "DIVINE CREAM",
        "BESTSELLER TRAVEL SET",
        "ZESTAW TOP 3 AMBASADORKI",
        "LI\u015aCIK \"DZI\u0118KUJ\u0118\"",
        "ZESTAW WIZA\u017bANKI NO.1",
        "DIVINE ANTI-WRINKLE BOOSTER",
        "MAGIC KEY",
        "SUPREME BALM SET",
        "ALL",
        "ANGEL HAIR SHAMPOO",
        "DIVINE ELIXIR",
        "TORBA PAPIEROWA SECRET",
        "HERBUS ZESTAW WSZECHREGENERACJI",
        "KARTKA \"KOCHAM CI\u0118\"",
        "PAPER BAG MAGIC FOREST SMALL GOLD PLATED",
        "DIVINE SKIN PREFECTOR SPF 50",
        "MINI DIVINE CREAM",
        "BON PREZENTOWY",
        "GIFT SET DIVINE ELIXIR & DIVINE CREAM ",
        "GIFT SET DIVINE CREAM & SUPREME BALM",
        "THE BIG BAG",
        "BALANCE SET",
        "GRAND BESTSELLER SET",
        "ALL SET",
        "SET SUPREME CLEANSER & SUPREME BALM",
        "MINI SUPREME GIFT SET",
        "ZESTAW ZABIEGANEJ MAMY",
        "BEST TRIO",
        "ZESTAW DLA NIEJ",
        "ZESTAW WSZECH CZAS\u00d3W",
        "SET FOR HER",
        "SUMMER SET NO.3",
        "ZESTAW M\u0141ODO\u015aCI W SZKATULE",
        "DIVINE SKIN PERFECTOR SPF 50 EN/DE",
        "SUMMER SET NO.1",
        "SUPREME HELP KIT",
        "DIVINE SECRET SERUM",
        "SET FOR HIM",
        "SUPREME HELP KIT ",
        "MINI SUPREME BALM \"MI\u0141O\u015a\u0106\"",
        "SUMMER SET NO.2",
        "BIG GIFT BAG FAIRYTALE",
        "TORBA PAPIEROWA DIVINE ACID PEELING",
        "DIVINE SECRET SET ",
        "SHADOW PRODUCT FOR FULLFILEMENTS DO NOT TOUCH",
        "BON PREZENTOWY - DIGITAL",
        "MINI GIFT SET",
        "SUPREME CLEANSER",
        "SET DIVINE ACID PEELING",
        "TORBA PAPIEROWA MAGIC FOREST",
        "ZESTAW WIZA\u017bANKI NO.2",
        "TALIZMAN \"4 HARMONIE\"",
        "PREFECT MATCH SET",
        "NO.1 SET"
      ],
      "type": "string",
      "title": "product",
      "description": "Product name",
      "x-order": 6
    },
    "end_date": {
      "type": "string",
      "title": "End Date",
      "x-order": 5,
      "description": "End date for the data retrieval e.g. 2024-03-01T07:25:18.724Z (the period should be at least one week)"
    },
    "password": {
      "type": "string",
      "title": "Password",
      "format": "password",
      "x-order": 2,
      "description": "Samarite API Password",
      "x-cog-secret": true
    },
    "start_date": {
      "type": "string",
      "title": "Start Date",
      "x-order": 4,
      "description": "Start date for the data retrieval e.g. 2024-01-01T07:25:18.724Z"
    },
    "predict_type": {
      "enum": [
        "rfm-score",
        "segmentation"
      ],
      "type": "string",
      "title": "predict_type",
      "description": "Prediction type",
      "default": "rfm-score",
      "x-order": 8
    },
    "show_metrics": {
      "type": "boolean",
      "title": "Show Metrics",
      "default": false,
      "x-order": 9,
      "description": "Whether to show the evaluation metrics"
    },
    "custom_product": {
      "type": "string",
      "title": "Custom Product",
      "x-order": 7,
      "description": "Custom product name"
    },
    "num_last_orders": {
      "type": "integer",
      "title": "Num Last Orders",
      "default": 0,
      "x-order": 3,
      "description": "Number of last orders to retrieve, more than 10000 and less than 200000"
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "type": "string",
  "title": "Output"
}