DialogStateManager クラス

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

実装

java.util.Map <java.lang.Stringjava.lang.Object> をする

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

DialogStateManager はメモリ スコープを管理し、pathresolvers MemoryScopes はルート レベルのオブジェクトという名前を付けます。これは、dialogcontext 内に存在するか、ターン状態を無効にして PathResolvers を使用して、$fooを dialog.foo にマッピングするためのショートカット動作を可能にします。

コンストラクターの概要

コンストラクター 説明
DialogStateManager(DialogContext dc)

DialogStateManager クラスの新しいインスタンスを初期化します。

DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

DialogStateManager クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
T <T>getValue(String pathExpression, T defaultValue, Class<T> clsType)

パス式を使用してメモリから値を取得します (注: これは常に値の複製を返します)。

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

パス式を使用してメモリから値を取得します (注: これは常に値の複製を返します)。

void add(String key, Object value)

ダイアログ状態マネージャーに要素を追加します。

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

ダイアログ状態マネージャーに項目を追加します。

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

透かし以降にパスが変更されているかどうかを確認します。

void clear()

ダイアログ状態マネージャーからすべての項目を削除します。

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

ダイアログ状態マネージャーに特定の値が含まれているかどうかを判断します。

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

ダイアログ状態マネージャーに、指定したキーを持つ要素が含まれているかどうかを判断します。

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

ダイアログ状態マネージャーの要素を、特定のインデックスから始まる配列にコピーします。

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

スコープのメモリを削除します。

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)

パス式を使用してメモリからブール値を取得します。

DialogStateManagerConfiguration getConfiguration()

ダイアログの構成済みのパス リゾルバーとメモリ スコープを設定します。

java.lang.Object getElement(String key)

指定したキーを持つ要素を取得します。

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

コレクションを反復処理する反復子を返します。

int getIntValue(String pathExpression, int defaultValue)

パス式を使用してメモリから int 値を取得します。

java.lang.Boolean getIsReadOnly()

ダイアログ状態マネージャーが読み取り専用かどうかを示す値を取得します。

MemoryScope getMemoryScope(String name)

名前でメモリスコープを取得します。

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

ログに適したすべてのメモリスコープを取得します。

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

パス式を使用してメモリから文字列値を取得します。

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

すべてのスコープを読み込みます。

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)

指定したキーを持つ要素をダイアログ状態マネージャーから削除します。

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

ダイアログ状態マネージャーから特定のオブジェクトの最初の出現箇所を削除します。

void removeValue(String path)

メモリからプロパティを削除します。

MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

メモリスコープ解決すると、メモリスコープが検索され、残りのパスが返されます。

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

すべてのスコープのすべての変更を保存します。

void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

ダイアログの構成済みのパス リゾルバーとメモリ スコープを設定します。

void setElement(String key, Object element)

指定したキーを持つ要素を設定します。

void setValue(String path, Object value)

メモリを値に設定します。

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

特定のパスが変更されたタイミングを追跡します。

java.lang.String transformPath(String path)

登録されたパストランスフォーマーを使用してパスを変換します。

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

指定したキーに関連付けられている値を取得します。

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

バージョンは、呼び出し元が更新プログラムを識別し、キャッシュを決定するのに役立ちます。

メソッドの継承元: 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

コンストラクターの詳細

DialogStateManager

public DialogStateManager(DialogContext dc)

DialogStateManager クラスの新しいインスタンスを初期化します。

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。

DialogStateManager

public DialogStateManager(DialogContext dc, DialogStateManagerConfiguration configuration)

DialogStateManager クラスの新しいインスタンスを初期化します。

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
configuration - ダイアログ状態マネージャーの構成。

メソッドの詳細

<T>getValue

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

パス式を使用してメモリから値を取得します (注: これは常に値の複製を返します)。

パラメーター:

pathExpression - 使用するパス式。
defaultValue - 見つからない場合に返される既定値。
clsType - 戻り値として要求される値の型。

戻り値:

パスが無効な場合は、結果または既定値。

<TypeT>tryGetValue

public ResultPair tryGetValue(String path, Class clsType)

パス式を使用してメモリから値を取得します (注: これは常に値の複製を返します)。

パラメーター:

path - 使用するパス式。
clsType - 結果として要求される型

戻り値:

結果としてブール型と要求された型 TypeT を持つ ResultPair

add

public void add(String key, Object value)

ダイアログ状態マネージャーに要素を追加します。

パラメーター:

key - 追加する要素のキー。
value - 追加する要素の値。

add

public void add(AbstractMap.SimpleEntry item)

ダイアログ状態マネージャーに項目を追加します。

パラメーター:

item - 追加する項目のキーとオブジェクトを含む SimpleEntry。

anyPathChanged

public Boolean anyPathChanged(int counter, Iterable paths)

透かし以降にパスが変更されているかどうかを確認します。

パラメーター:

counter - 比較する時間カウンター。
paths - 確認するトラックパスからのパス。

戻り値:

True カウンター以降にパスが変更された場合です。

clear

public void clear()

ダイアログ状態マネージャーからすべての項目を削除します。

contains

public Boolean contains(AbstractMap.SimpleEntry item)

ダイアログ状態マネージャーに特定の値が含まれているかどうかを判断します。

パラメーター:

item - 検索する項目の値。

戻り値:

True の 場合は、ダイアログ状態マネージャーで項目が見つかりました。それ以外の場合、false

containsKey

public final boolean containsKey(Object key)

パラメーター:

key

containsKey

public Boolean containsKey(String key)

ダイアログ状態マネージャーに、指定したキーを持つ要素が含まれているかどうかを判断します。

パラメーター:

key - ダイアログ状態マネージャーで検索するキー。

戻り値:

ダイアログ状態マネージャーにキーを持つ要素が含まれている場合は true。それ以外の場合は false。

containsValue

public final boolean containsValue(Object value)

パラメーター:

value

copyTo

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

ダイアログ状態マネージャーの要素を、特定のインデックスから始まる配列にコピーします。

パラメーター:

array - ダイアログ状態マネージャーからコピーされた要素のコピー先である 1 次元配列。 配列には、0 から始まるインデックスが必要です。
arrayIndex - コピーを開始する配列内の 0 から始まるインデックス。

deleteScopesMemory

public CompletableFuture deleteScopesMemory(String name)

スコープのメモリを削除します。

パラメーター:

name - スコープの名前

戻り値:

CompletedableFuture

entrySet

public final Set> entrySet()

get

public final Object get(Object key)

パラメーター:

key

getBoolValue

public Boolean getBoolValue(String pathExpression, Boolean defaultValue)

パス式を使用してメモリからブール値を取得します。

パラメーター:

pathExpression - パス式。
defaultValue - 値が存在しない場合の既定値。

戻り値:

パスが無効な場合は値または既定値。

getConfiguration

public DialogStateManagerConfiguration getConfiguration()

ダイアログの構成済みのパス リゾルバーとメモリ スコープを設定します。

戻り値:

DialogStateManagerConfiguration。

getElement

public Object getElement(String key)

指定したキーを持つ要素を取得します。

パラメーター:

key - 要素を取得または設定するキー。

戻り値:

指定したキーを持つ要素。

getEnumerator

public Iterable> getEnumerator()

コレクションを反復処理する反復子を返します。

戻り値:

コレクションを反復処理するために使用できる反復子。

getIntValue

public int getIntValue(String pathExpression, int defaultValue)

パス式を使用してメモリから int 値を取得します。

パラメーター:

pathExpression - パス式。
defaultValue - 値が存在しない場合の既定値。

戻り値:

パスが無効な場合は値または既定値。

getIsReadOnly

public Boolean getIsReadOnly()

ダイアログ状態マネージャーが読み取り専用かどうかを示す値を取得します。

戻り値:

getMemoryScope

public MemoryScope getMemoryScope(String name)

名前で MemoryScope を取得します。

パラメーター:

name - スコープの名前。

戻り値:

メモリ スコープ。

getMemorySnapshot

public JsonNode getMemorySnapshot()

ログに適したすべてのメモリスコープを取得します。

戻り値:

すべてのメモリ スコープを表す JsonNode。

getStringValue

public String getStringValue(String pathExpression, String defaultValue)

パス式を使用してメモリから文字列値を取得します。

パラメーター:

pathExpression - パス式。
defaultValue - 値が存在しない場合の既定値。

戻り値:

パスが無効な場合は文字列または既定値。

isEmpty

public final boolean isEmpty()

keySet

public final Set keySet()

loadAllScopes

public CompletableFuture loadAllScopes()

すべてのスコープを読み込みます。

戻り値:

完成した未来。

put

public final Object put(String key, Object value)

パラメーター:

key
value

putAll

public final void putAll(Map m)

パラメーター:

m

remove

public final Object remove(Object key)

パラメーター:

key

remove

public Boolean remove(String key)

指定したキーを持つ要素をダイアログ状態マネージャーから削除します。

パラメーター:

key - 削除する要素のキー。

戻り値:

要素が正常に削除された場合は true。それ以外の場合は false。

remove

public boolean remove(AbstractMap.SimpleEntry item)

ダイアログ状態マネージャーから特定のオブジェクトの最初の出現箇所を削除します。

パラメーター:

item - ダイアログ状態マネージャーから削除するオブジェクト。

戻り値:

アイテムがダイアログ状態マネージャーから正常に削除された場合は true、それ以外の場合は false

removeValue

public void removeValue(String path)

メモリからプロパティを削除します。

パラメーター:

path - リーフ プロパティを削除するパス。

resolveMemoryScope

public MemoryScope resolveMemoryScope(String path, StringBuilder remainingPath)

ResolveMemoryScope は MemoryScope を検索し、残りのパスを返します。

パラメーター:

path - スコープと残りのパスに解決する受信パス。
remainingPath - スコープ内の残りのサブパス。

戻り値:

メモリ スコープ。

saveAllChanges

public CompletableFuture saveAllChanges()

すべてのスコープのすべての変更を保存します。

戻り値:

Completed Future

setConfiguration

public void setConfiguration(DialogStateManagerConfiguration withDialogStateManagerConfiguration)

ダイアログの構成済みのパス リゾルバーとメモリ スコープを設定します。

パラメーター:

withDialogStateManagerConfiguration - 設定する構成。

setElement

public void setElement(String key, Object element)

指定したキーを持つ要素を設定します。

パラメーター:

key - 要素を取得または設定するキー。
element - 指定されたキーと共に格納する要素。

setValue

public void setValue(String path, Object value)

メモリを値に設定します。

パラメーター:

path - メモリへのパス。
value - 設定するオブジェクト。

size

public final int size()

trackPaths

public List trackPaths(Iterable paths)

特定のパスが変更されたタイミングを追跡します。

パラメーター:

paths - 追跡するパス。

戻り値:

AnyPathChanged に渡す正規化されたパス。

transformPath

public String transformPath(String path)

登録済みの PathTransformers を使用してパスを変換します。

パラメーター:

path - 変換するパス。

戻り値:

変換されたパス。

tryGetValue

public ResultPair tryGetValue(String key, Object value)

指定したキーに関連付けられている値を取得します。

パラメーター:

key - 取得する値を持つキー。
value - このメソッドから制御が戻るときに、指定したキーに関連付けられている値 (キーが見つかった場合)。それ以外の場合は、値パラメーターの型の既定値。

戻り値:

ダイアログ状態マネージャーに指定されたキーを持つ要素が含まれている場合は true。

values

public final Collection values()

version

public String version()

バージョンは、呼び出し元が更新プログラムを識別し、キャッシュを決定するのに役立ちます。

戻り値:

現在のバージョン

適用対象