DialogStateManager Classe

  • java.lang.Object
    • com.microsoft.bot.dialogs.memory.DialogStateManager

Implémente

java.util.Map<java.lang.String,java.lang.Object>

public class DialogStateManager
implements java.util.Map<java.lang.String,java.lang.Object>

DialogStateManager gère les étendues de mémoire et les pathresolvers MemoryScopes sont des objets de niveau racine nommés, qui peuvent exister dans le dialoguecontexte ou désactivé de l’état PathResolvers autorisent le comportement de raccourci pour le mappage des éléments tels que $foo à dialog.foo.

Récapitulatif du constructeur

Constructeur Description
DialogStateManager(DialogContext dc)

Initialise une nouvelle instance de la classe DialogStateManager.

DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

Initialise une nouvelle instance de la classe DialogStateManager.

Résumé de la méthode

Modificateur et type Méthode et description
T <T>getValue(String pathExpression, T defaultValue, Class<T> clsType)

Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès (REMARQUE : cela retourne toujours le clone de valeur).

ResultPair<TypeT> <TypeT>tryGetValue(String path, Class<TypeT> clsType)

Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès (REMARQUE : cela retourne toujours le clone de valeur).

void add(String key, Object value)

Ajoute un élément au gestionnaire d’état de boîte de dialogue.

void add(AbstractMap.SimpleEntry<String,Object> item)

Ajoute un élément au gestionnaire d’état de boîte de dialogue.

java.lang.Boolean anyPathChanged(int counter, Iterable<String> paths)

Vérifiez si un chemin d’accès a changé depuis le filigrane.

void clear()

Supprime tous les éléments du gestionnaire d’état de boîte de dialogue.

java.lang.Boolean contains(AbstractMap.SimpleEntry<String,Object> item)

Détermine si le gestionnaire d’état de boîte de dialogue contient une valeur spécifique.

final boolean containsKey(Object key)
java.lang.Boolean containsKey(String key)

Détermine si le gestionnaire d’état de boîte de dialogue contient un élément avec la clé spécifiée.

final boolean containsValue(Object value)
void copyTo(AbstractMap.SimpleEntry<String,Object>[] array, int arrayIndex)

Copie les éléments du gestionnaire d’état de boîte de dialogue dans un tableau commençant à un index particulier.

java.util.concurrent.CompletableFuture<java.lang.Void> deleteScopesMemory(String name)

Supprimez la mémoire d’une étendue.

final java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
final java.lang.Object get(Object key)
java.lang.Boolean getBoolValue(String pathExpression, Boolean defaultValue)

Obtenez une valeur booléenne à partir de la mémoire à l’aide d’une expression de chemin d’accès.

DialogStateManagerConfiguration getConfiguration()

Définit les programmes de résolution de chemin configurés et les étendues de mémoire pour la boîte de dialogue.

java.lang.Object getElement(String key)

Obtient les éléments avec la clé spécifiée.

java.lang.Iterable<java.util.AbstractMap.SimpleEntry<java.lang.String,java.lang.Object>> getEnumerator()

Retourne un itérateur qui itère dans la collection.

int getIntValue(String pathExpression, int defaultValue)

Obtenez une valeur int de la mémoire à l’aide d’une expression de chemin d’accès.

java.lang.Boolean getIsReadOnly()

Obtient une valeur indiquant si le gestionnaire d’état de boîte de dialogue est en lecture seule.

MemoryScope getMemoryScope(String name)

Obtenez l’étendue de la mémoirepar nom.

com.fasterxml.jackson.databind.JsonNode getMemorySnapshot()

Obtient toutes les portées mémoire appropriées pour la journalisation.

java.lang.String getStringValue(String pathExpression, String defaultValue)

Obtenez une valeur string à partir de la mémoire à l’aide d’une expression de chemin d’accès.

final boolean isEmpty()
final java.util.Set<java.lang.String> keySet()
java.util.concurrent.CompletableFuture<java.lang.Void> loadAllScopes()

Chargez toutes les étendues.

final java.lang.Object put(String key, Object value)
final void putAll(Map<? extends String,? extends Object> m)
final java.lang.Object remove(Object key)
java.lang.Boolean remove(String key)

Supprime l’élément avec la clé spécifiée du gestionnaire d’état de boîte de dialogue.

boolean remove(AbstractMap.SimpleEntry<String,Object> item)

Supprime la première occurrence d’un objet spécifique du gestionnaire d’état de boîte de dialogue.

void removeValue(String path)

Supprimez la propriété de la mémoire.

MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

Résolvezétendue demémoire recherche l’étendue de la mémoireet retourne le chemin restant.

java.util.concurrent.CompletableFuture<java.lang.Void> saveAllChanges()

Enregistrez toutes les modifications pour toutes les étendues.

void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

Définit les programmes de résolution de chemin configurés et les étendues de mémoire pour la boîte de dialogue.

void setElement(String key, Object element)

Définit les éléments avec la clé spécifiée.

void setValue(String path, Object value)

Définissez la mémoire sur la valeur.

final int size()
java.util.List<java.lang.String> trackPaths(Iterable<String> paths)

Effectuez le suivi lorsque des chemins spécifiques sont modifiés.

java.lang.String transformPath(String path)

Transformez le chemin à l’aide du chemin d’accès inscritTransformateurs.

ResultPair<java.lang.Object> tryGetValue(String key, Object value)

Obtient la valeur associée à la clé spécifiée.

final java.util.Collection<java.lang.Object> values()
java.lang.String version()

L’appelant d’aide à la version pour identifier les mises à jour et décider du cache ou non.

Méthodes héritées de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Détails du constructeur

DialogStateManager

public DialogStateManager(DialogContext dc)

Initialise une nouvelle instance de la classe DialogStateManager.

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.

DialogStateManager

public DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

Initialise une nouvelle instance de la classe DialogStateManager.

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.
configuration - Configuration du gestionnaire d’état de boîte de dialogue.

Détails de la méthode

<T>getValue

public T getValue(String pathExpression, T defaultValue, Class clsType)

Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès (REMARQUE : cela retourne toujours le clone de valeur).

Paramètres:

pathExpression - Expression de chemin à utiliser.
defaultValue - Valeur par défaut à retourner si aucune valeur n’est trouvée.
clsType - Type de valeur demandée en tant que retour.

Retours:

Résultat ou valeur par défaut si le chemin d’accès n’est pas valide.

<TypeT>tryGetValue

public ResultPair tryGetValue(String path, Class clsType)

Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès (REMARQUE : cela retourne toujours le clone de valeur).

Paramètres:

path - expression de chemin d’accès à utiliser.
clsType - type demandé en conséquence

Retours:

ResultPair avec type TypeT booléen et demandé en conséquence

add

public void add(String key, Object value)

Ajoute un élément au gestionnaire d’état de boîte de dialogue.

Paramètres:

key - Clé de l’élément à ajouter.
value - Valeur de l’élément à ajouter.

add

public void add(AbstractMap.SimpleEntry item)

Ajoute un élément au gestionnaire d’état de boîte de dialogue.

Paramètres:

item - SimpleEntry avec la clé et l’objet de l’élément à ajouter.

anyPathChanged

public Boolean anyPathChanged(int counter, Iterable paths)

Vérifiez si un chemin d’accès a changé depuis le filigrane.

Paramètres:

counter - Compteur de temps à comparer.
paths - Chemins d’accès des trackpaths à vérifier.

Retours:

True si un chemin d’accès a changé depuis le compteur.

clear

public void clear()

Supprime tous les éléments du gestionnaire d’état de boîte de dialogue.

contains

public Boolean contains(AbstractMap.SimpleEntry item)

Détermine si le gestionnaire d’état de boîte de dialogue contient une valeur spécifique.

Paramètres:

item - Élément à localiser.

Retours:

True si l’élément est trouvé dans le gestionnaire d’état de boîte de dialogue ; sinon, false

containsKey

public final boolean containsKey(Object key)

Paramètres:

key

containsKey

public Boolean containsKey(String key)

Détermine si le gestionnaire d’état de boîte de dialogue contient un élément avec la clé spécifiée.

Paramètres:

key - Clé à localiser dans le gestionnaire d’état de boîte de dialogue.

Retours:

true si le gestionnaire d’état de boîte de dialogue contient un élément avec la clé ; sinon, false.

containsValue

public final boolean containsValue(Object value)

Paramètres:

value

copyTo

public void copyTo(AbstractMap.SimpleEntry[] array, int arrayIndex)

Copie les éléments du gestionnaire d’état de boîte de dialogue dans un tableau commençant à un index particulier.

Paramètres:

array - Tableau unidimensionnel qui est la destination des éléments copiés à partir du gestionnaire d’état de boîte de dialogue. Le tableau doit avoir une indexation de base zéro.
arrayIndex - Index de base zéro dans le tableau au début de la copie.

deleteScopesMemory

public CompletableFuture deleteScopesMemory(String name)

Supprimez la mémoire d’une étendue.

Paramètres:

name - nom de l’étendue

Retours:

CompletableFuture terminé

entrySet

public final Set> entrySet()

get

public final Object get(Object key)

Paramètres:

key

getBoolValue

public Boolean getBoolValue(String pathExpression, Boolean defaultValue)

Obtenez une valeur booléenne à partir de la mémoire à l’aide d’une expression de chemin d’accès.

Paramètres:

pathExpression - Expression de chemin d’accès.
defaultValue - Valeur par défaut si la valeur n’existe pas.

Retours:

Valeur ou valeur par défaut si le chemin d’accès n’est pas valide.

getConfiguration

public DialogStateManagerConfiguration getConfiguration()

Définit les programmes de résolution de chemin configurés et les étendues de mémoire pour la boîte de dialogue.

Retours:

The DialogStateManagerConfiguration.

getElement

public Object getElement(String key)

Obtient les éléments avec la clé spécifiée.

Paramètres:

key - Clé pour obtenir ou définir l’élément.

Retours:

Élément avec la clé spécifiée.

getEnumerator

public Iterable> getEnumerator()

Retourne un itérateur qui itère dans la collection.

Retours:

Itérateur qui peut être utilisé pour itérer dans la collection.

getIntValue

public int getIntValue(String pathExpression, int defaultValue)

Obtenez une valeur int de la mémoire à l’aide d’une expression de chemin d’accès.

Paramètres:

pathExpression - Expression de chemin d’accès.
defaultValue - Valeur par défaut si la valeur n’existe pas.

Retours:

Valeur ou valeur par défaut si le chemin d’accès n’est pas valide.

getIsReadOnly

public Boolean getIsReadOnly()

Obtient une valeur indiquant si le gestionnaire d’état de boîte de dialogue est en lecture seule.

Retours:

vrai

getMemoryScope

public MemoryScope getMemoryScope(String name)

Obtenez MemoryScope par nom.

Paramètres:

name - Nom de l’étendue.

Retours:

Étendue de mémoire.

getMemorySnapshot

public JsonNode getMemorySnapshot()

Obtient toutes les portées mémoire appropriées pour la journalisation.

Retours:

JsonNode qui représente toutes les étendues de mémoire.

getStringValue

public String getStringValue(String pathExpression, String defaultValue)

Obtenez une valeur string à partir de la mémoire à l’aide d’une expression de chemin d’accès.

Paramètres:

pathExpression - Expression de chemin d’accès.
defaultValue - Valeur par défaut si la valeur n’existe pas.

Retours:

Chaîne ou valeur par défaut si le chemin d’accès n’est pas valide.

isEmpty

public final boolean isEmpty()

keySet

public final Set keySet()

loadAllScopes

public CompletableFuture loadAllScopes()

Chargez toutes les étendues.

Retours:

Un avenir terminé.

put

public final Object put(String key, Object value)

Paramètres:

key
value

putAll

public final void putAll(Map m)

Paramètres:

m

remove

public final Object remove(Object key)

Paramètres:

key

remove

public Boolean remove(String key)

Supprime l’élément avec la clé spécifiée du gestionnaire d’état de boîte de dialogue.

Paramètres:

key - Clé de l’élément à supprimer.

Retours:

true si l’élément est supprimé correctement ; sinon, false.

remove

public boolean remove(AbstractMap.SimpleEntry item)

Supprime la première occurrence d’un objet spécifique du gestionnaire d’état de boîte de dialogue.

Paramètres:

item - Objet à supprimer du gestionnaire d’état de boîte de dialogue.

Retours:

true si l’élément a été correctement supprimé du gestionnaire d’état de boîte de dialogue sinon false

removeValue

public void removeValue(String path)

Supprimez la propriété de la mémoire.

Paramètres:

path - Chemin d’accès pour supprimer la propriété feuille.

resolveMemoryScope

public MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

ResolveMemoryScope recherche le MemoryScope pour et retourne le chemin restant.

Paramètres:

path - Chemin entrant à résoudre en étendue et chemin restant.
remainingPath - Sous-chemin restant dans l’étendue.

Retours:

Étendue de la mémoire.

saveAllChanges

public CompletableFuture saveAllChanges()

Enregistrez toutes les modifications pour toutes les étendues.

Retours:

Fin de l’avenir

setConfiguration

public void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

Définit les programmes de résolution de chemin configurés et les étendues de mémoire pour la boîte de dialogue.

Paramètres:

withDialogStateManagerConfiguration - Configuration à définir.

setElement

public void setElement(String key, Object element)

Définit les éléments avec la clé spécifiée.

Paramètres:

key - Clé pour obtenir ou définir l’élément.
element - Élément à stocker avec la clé fournie.

setValue

public void setValue(String path, Object value)

Définissez la mémoire sur la valeur.

Paramètres:

path - Chemin d’accès à la mémoire.
value - Objet à définir.

size

public final int size()

trackPaths

public List trackPaths(Iterable paths)

Effectuez le suivi lorsque des chemins spécifiques sont modifiés.

Paramètres:

paths - Chemins d’accès au suivi.

Retours:

Chemins normalisés à passer à AnyPathChanged.

transformPath

public String transformPath(String path)

Transformez le chemin à l’aide des PathTransformers inscrits.

Paramètres:

path - Chemin d’accès à transformer.

Retours:

Chemin transformé.

tryGetValue

public ResultPair tryGetValue(String key, Object value)

Obtient la valeur associée à la clé spécifiée.

Paramètres:

key - Clé dont la valeur doit être obtenu.
value - Lorsque cette méthode est retournée, la valeur associée à la clé spécifiée, si la clé est trouvée ; sinon, valeur par défaut pour le type du paramètre valeur.

Retours:

true si le gestionnaire d’état de boîte de dialogue contient un élément avec la clé spécifiée ;

values

public final Collection values()

version

public String version()

L’appelant d’aide à la version pour identifier les mises à jour et décider du cache ou non.

Retours:

Version actuelle

S’applique à