🔌API client

Panoramica

Un modulo npm che fa da wrapper alle API di backend e engine. Gestisce le chiamate API ed espone i metodi disponibili con parametri e risposte tipizzati. Può essere utilizzato sia sul lato web sia sul lato node/server.

Architettura API

L'API Memori è composta da due componenti principali:

1. API Engine (Swagger)

   1. Gestisce sessioni e dialoghi;

   2. Gestisce le funzionalità NLP;

   3. Elabora le funzionalità conversazionali.

2. API Backend (Swagger)

   1. Gestisce utenti e asset;

   2. Gestisce le notifiche;

   3. Controlla l'amministrazione del sistema.

Inizializzazione del client

import memoriApiClient from "@memori.ai/memori-api-client";
// Initialize with default endpoints
const memori = memoriApiClient(
"https://backend.memori.ai", // API URL
"https://engine.memori.ai" // Engine URL
);

Funzionalità principali

Gestione delle sessioni

// Initialize a basic session
const {
  sessionID,
  currentState
} = await memori.initSession({
  memoriID: "your-memori-id",
  birthdate: "1900-01-01T00:00:00.000Z",
});
// Initialize a session with context
const sessionWithContext = await memori.initSession({
  memoriID: "your-memori-id",
  birthdate: "1900-01-01T00:00:00.000Z",
  context: {
    location: "Milan",
    userType: "premium",
    customVariable: "value",
  },
});

Eventi di dialogo

// Send a text message
const {
  currentState: dialogState
} = await memori.postTextEnteredEvent({
  sessionId: sessionID,
  text: "Hello Memori!",
});
// Change date context
await memori.postDateChangedEvent({
  sessionId: sessionID,
  date: "2024-12-13",
});
// Change location context
await memori.postPlaceChangedEvent({
  sessionId: sessionID,
  place: "Rome",
});

Funzionalità avanzate

Gestione dello stato globale

// Get current state
const state = getMemoriState();
const sessionID = getMemoriState().sessionID;
// For multiple widgets
const specificState = getMemoriState("widget-integration-id");
// Read state manually from the DOM
const dialogState = JSON.parse(document.querySelector("div[data-memori-engine-state]") ? .dataset ? .memoriEngineState ? ?"{}");

Listener di eventi

MemoriNewDialogState

Puoi ascoltare ogni messaggio usando l'evento MemoriNewDialogState e valutarne il contenuto per attivare una reazione

// Listen for state changes
document.addEventListener("MemoriNewDialogState", (e) = >{
  const {
    emission,
    context,
    sessionID
  } = e.detail;
  // Log analytics
  logConversation({
    sessionId: sessionID,
    message: emission,
    timestamp: new Date(),
    context: context,
  });
  // Handle specific responses
  if (emission.includes("help")) {
    showHelpPanel();
  }
});
// Handle end of speech
document.addEventListener("MemoriEndSpeak", () = >{
  clearCustomElements();
  checkConversationFlow();
});

Invio di messaggi

// Basic message
typeMessage("Hello!");
// Advanced message with options
typeMessage("Show product catalog", true, // wait for previous message
false, // show in chat
"Loading catalog..." // loading text
);
// Don't show the message in chat
typeMessageHidden("analyze_sentiment", true);

Esempio completo di integrazione API

import memoriApiClient from "@memori.ai/memori-api-client";

async function memoriConversation() {
  // Initialize client
  const memori = memoriApiClient("https://backend.memori.ai", "https://engine.memori.ai");

  try {
    // Start session
    const {
      sessionID,
      currentState
    } = await memori.initSession({
      memoriID: "your-memori-id",
      birthdate: "1900-01-01T00:00:00.000Z",
      context: {
        location: "Milan",
        userType: "premium",
      },
    });

    // Send initial message
    const {
      currentState: firstResponse
    } = await memori.postTextEnteredEvent({
      sessionId: sessionID,
      text: "Hello! Tell me about yourself.",
    });
    console.log("Memori says:", firstResponse.emission);

    // Update context
    await memori.postPlaceChangedEvent({
      sessionId: sessionID,
      place: "Rome",
    });

    // Send next message
    const {
      currentState: secondResponse
    } = await memori.postTextEnteredEvent({
      sessionId: sessionID,
      text: "What can you tell me about this location?",
    });
    console.log("Memori says:", secondResponse.emission);

    // Run NLP analysis
    const language = await memori.guessLanguage(sessionID, secondResponse.emission);
    console.log("Response language:", language);

    // Close session
    await memori.closeSession(sessionID);
  } catch(error) {
    console.error("Error:", error.resultMessage);
  }
}