API

Con la piattaforma Portrait è possibile creare una chiave API di Profilazione Psicometrica in modo da facilitare l’integrazione della tecnologia con altri sistemi.

NB: I token API consentono ai servizi di terze parti di autenticarsi con la nostra applicazione per tuo conto.

Per iniziare a creare la chiave API di Profilazione Psicometrica segui la procedura descritta nella serie di immagini qui sotto.

Per prima cosa clicca sulla voce di menu API come mostrato nella figura qui sotto:

Nella finestra che si aprirà potrai creare la tua chiave di integrazione API con la tecnologia di Portrait.

NB: Un token di default viene creato automaticamente dalla piattaforma, come mostrato in figura:

Inizia scrivendo un nome significativo del token API che ricordi in quale sistema stai integrando la profilazione psicometrica:

Clicca sul tasto “crea” come mostrato in figura per iniziare la configurazione della chiave API:

A questo punto sarà aggiunta in basso la tua chiave con il nome da te scelto, come mostrato in figura qui sotto:

Utilizza il tasto “copia” per copiare il numero del tuo token e integrarlo nel tuo sistema preferito.

Utilizza l’icona del cestino per rimuovere definitivamente la chiave.

NB: Elimina tutti i tuoi token API esistenti se non sono più necessari.

COME FARE UNA RICHIESTA API

curl --location 'https://app.portrait-profiling.ai/api/profile' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: pa_*******' \
--data '{
  "text": "I am a very good person",
  "llm_goal": "I would like to know if the user is prone to make online purchases",
  "llm_language": "en",
  "correlations_matrix_all": false,
  "correlations_matrix": []
}

AUTENTICAZIONE

Per autenticarsi è necessario passare l’header X-API-Key con il valore di uno dei token che sono stati generati.
Per maggiori informazioni su come generare un token vai all’inizio di questa pagina.

PARAMETRI

• text (string, required) – Testo da analizzare
• correlations_matrix_all (boolean, optional) – Se true, vengono calcolate tutte le matrici di correlazione create. Default: false
• correlations_matrix (array, optional) – Array contente gli id delle matrici di correlazione che si devono calcolare. Se correlations_matrix_all è true, questo parametro viene ignorato.
• llm_goal: (string, optional) – Testo che rappresenta l’obiettivo della profilazione da passare all’LLM.
• llm_language: (string,optional) – Lingua del testo da passare all’LLM per la valutazione dell’obiettivo. Default: “en”, accettati: [it|en|fr|de|es]

RISPOSTA

{
  "profile": {
    "behav_decisionmaking": 0.001,
    "behav_impressionmanagement": 0.001,
    "behav_lifesatisfaction": 0.001,
    "behav_spendingattitude": 0.001,
    "net_transitivity": 0.001,
    "pers_adventurous": 0.001,
    "pers_agreeableness": 0.001,
    "pers_altruism": 0.001,
    "pers_anger": 0.001,
    "pers_anxiety": 0.001,
    "pers_art_interests": 0.001,
    "pers_assertiveness": 0.001,
    "pers_caution": 0.001,
    "pers_cheerfulness": 0.001,
    "pers_conscientiousness": 0.001,
    "pers_cooperativity": 0.001,
    "pers_creativity": 0.001,
    "pers_depression": 0.001,
    "pers_discipline": 0.001,
    "pers_efficacy": 0.001,
    "pers_emotion": 0.001,
    "pers_excitability": 0.001,
    "pers_extroversion": 0.001,
    "pers_friendlyness": 0.001,
    "pers_gregariousness": 0.001,
    "pers_immoderability": 0.001,
    "pers_intellectual": 0.001,
    "pers_liberal": 0.001,
    "pers_modesty": 0.001,
    "pers_morality": 0.001,
    "pers_neuroticism": 0.001,
    "pers_openness": 0.001,
    "pers_order": 0.001,
    "pers_proactivity": 0.001,
    "pers_selfcontrol": 0.001,
    "pers_sense_of_duty": 0.001,
    "pers_simpathy": 0.001,
    "pers_trust": 0.001,
    "pers_vulnerability": 0.001,
    "pers_will": 0.001,
    "values_achievement": 0.001,
    "values_benevolence": 0.001,
    "values_conformity": 0.001,
    "values_hedonism": 0.001,
    "values_power": 0.001,
    "values_security": 0.001,
    "values_self-direction": 0.001,
    "values_stimulation": 0.001,
    "values_tradition": 0.001,
    "values_universalism": 0.001
  },
  "aggregated_profile": {
    "Adv-LikesAlternativeCommunication":  0.5,
    "Adv-LikesLogicalCommunication":  0.5,
    "Adv-LikesTraditionalCommunication":  0.5,
    "Adv-LikesUpbeatCommunication":  0.5,
    "Attitude-Attractiveness":  0.5,
    "Attitude-Churn":  0.5,
    "Attitude-Dominance":  0.5,
    "Attitude-LoyalCustomer":  0.5,
    "Attitude-OpenToInnovation":  0.5,
    "Attitude-Passivity":  0.5,
    "Attitude-Prosocial":  0.5,
    "Attitude-Radicalization":  0.5,
    "Attitude-SelfTrascendence":  0.5,
    "Attitude-SensationSeeker":  0.5,
    "Attitude-ShareEmotionalPosts":  0.5,
    "Cognition-HighAttention":  0.5,
    "Cognition-Plasticity":  0.5,
    "Cognition-Stability":  0.5,
    "Credit-RepayDebt":  0.5,
    "Insurance-Coverage": 0.5,
    "Job-CareerSeeking":  0.5,
    "Job-DecisionMaking":  0.5,
    "Job-EffectiveLearnigStyle":  0.5,
    "Job-GroupTaskProficiency":  0.5,
    "Job-IndividualTaskProficiency":  0.5,
    "Job-NotManagingStress":  0.5,
    "Job-RelationalAbility":  0.5,
    "Purchase-Compulsivebuyer":  0.5,
    "Purchase-HighSpending":  0.5,
    "Purchase-Impulsivebuyer":  0.5,
    "PurchaseMotivation-SeekBelonging":  0.5,
    "PurchaseMotivation-SeekSelfEnhance":  0.5,
    "PurchaseMotivation-SeekStatusDisplay":  0.5,
    "Relationship-Anxiety":  0.5,
    "Relationship-Avoidance":  0.5,
    "Relationship-Quality":  0.5,
    "Wellbeing-HealthyStyle":  0.5,
    "Wellbeing-LifeSatisfaction":  0.5
  },
  "traffic_lights": [
    {
      "correlation_matrix_id": "uuid",
      "name": "traffic_lights",
      "switched_on": true
    }
  ],
  "goal_response": "risposta dell'LLM",
  "remaining_credits": 0
}

profile

profile restituisce tutte le informazioni (tutti i tratti) sul profilo analizzato da portrait.

aggregated_profile

aggregated_profile restituisce solo le informazioni sui tratti aggregati dell’utente analizzato da Portrait.

NB: vengono restituiti solo i campi più rilevanti per il profilo generato.

traffic_lights

Traffic_lights restituisce un array contenente i semafori richiesti, sono sempre restituiti:

• correlation_matrix_id (string) – id della matrice di correlazione
• name (string) – nome del semaforo
• switched_on (boolean) – se il semaforo è attivo

l’api restituisce tutti i semafori creati se il parametro correlations_matrix_all è true, altrimenti restituisce solo indicati nel parametro correlations_matrix.

goal_response

Goal_response restituisce la risposta dell’LLM riguardo l’obiettivo richiesto e il profilo dell’utente generato da Portrait.

remaining_credits

remaining_credits restituisce il numero di crediti rimanenti nel tuo account di Portrait.

ESEMPIO DI UTILIZZO DELLE API

Vediamo in questo esempio come utilizzare le API di Portrait per migliorare la comunicazione con i tuoi utenti, collegando un chatbot.

In questo modo, il chatbot sarà in grado di rilevare i tratti psicometrici dell’interlocutore, di evidenziare il rischio di churn, la propensione all’acquisto, l’up-selling il cross-selling, la predilezione per una comunicazione di tipo logico vs creativo, etc. e di adeguare la comunicazione di conseguenza.

Clicca qui per accedere alla documentazione della nostra piattaforma di creazione chatbot crafter.ai per avere una panoramica di integrazione della tecnologia Portrait all’interno di una soluzione di conversational AI.