Aller au contenu principal

Configuration minimale

Pour connaître toutes les options de configuration, voir la section Configurations.

Depuis la version 1.0.17 du Retorik Framework, les propriétés nécessaires au lancement de l'application ont été fortement réduites, se limitant à :

  • addressData qui contient les données du tenant auquel l'application va se connecter
  • widgetData uniquement en mode widget

Le reste des données sera automatiquement récupéré depuis Retorik Studio. Vous pouvez toutefois les surcharger en les renseignant comme avant.

Version de Retorik Framework supérieure ou égale à 1.0.17

Si vous utilisez typescript dans votre projet, vous pouvez importer les types de données suivants afin de faciliter la mise en place des données de configuration :

Import types typescript
import type {
  AddressData,
  WidgetConfiguration // mode widget uniquement
} from '@davi-ai/retorik-framework';

Les données minimales nécessaires au bon fonctionnement de l'application, qui devront être renseignées lors de l'instanciation du composant principal, sont les suivantes :

Configuration minimale
const addressData: AddressData = {
  tenant: '<nom_du_tenant>'
  /* le tenant est dans votre adresse Studio Retorik : https://studio.retorik.ai/tenant/... */
};

/* Nécessaire pour l'utilisation en mode widget */
const widgetConfiguration: WidgetConfiguration = {}
Version de Retorik Framework inférieure à 1.0.17

Si vous utilisez typescript dans votre projet, vous pouvez importer les types de données suivants afin de faciliter la mise en place des données de configuration :

Import types typescript
import type {
  AddressData,
  Configuration,
  PonyfillFactoryCredentials,
  ViewsConfiguration,
  WidgetConfiguration // mode widget uniquement
} from '@davi-ai/retorik-framework';

Les données minimales nécessaires au bon fonctionnement de l'application, qui devront être renseignées lors de l'instanciation du composant principal, sont les suivantes :

Configuration minimale
import characters from '@davi-ai/retorik-framework';

const configuration: Configuration = {};
const viewsConfig: ViewsConfiguration = {
  homeRoute: 'home',
  home: {
    background: {
      style: 'image',
      image: ''
    }
  }
};
const agentData: string = characters.zahra;
const ponyfillFactoryCredentials: PonyfillFactoryCredentials = {
  region: '<region>',
  subscriptionKey: '<subscription_key>',
};
const addressData: AddressData = {
  tenant: '<nom_du_tenant>'
  /* le tenant est dans votre adresse Studio Retorik : https://studio.retorik.ai/tenant/... */
};

/* Nécessaire pour l'utilisation en mode widget */
const widgetConfiguration: WidgetConfiguration = {}