Írás közvetlenül a tárolóba
A KÖVETKEZŐKRE VONATKOZIK: SDK v4
A köztes szoftver vagy a környezetobjektum használata nélkül közvetlenül is olvashat és írhat a tárolóobjektumba. Ez megfelelő lehet a robot által a beszélgetések megőrzéséhez használt adatokhoz, illetve a robot beszélgetési folyamatán kívüli forrásból származó adatokhoz. Ebben az adattárolási modellben az adatok közvetlenül a tárolóból olvasnak be állapotkezelő helyett. A cikkben szereplő példakódok bemutatják, hogyan olvashat és írhat adatokat a tárolóba memória, Cosmos DB, Azure Blob és Azure Blob átirattároló használatával.
Feljegyzés
A Bot Framework JavaScript, C# és Python SDK-k továbbra is támogatottak lesznek, a Java SDK-t azonban 2023 novemberében végső hosszú távú támogatással kivonják.
A Java SDK-val létrehozott meglévő robotok továbbra is működni fognak.
Az új robotépítéshez fontolja meg a Microsoft Copilot Studio használatát, és olvassa el a megfelelő copilot-megoldás kiválasztását.
További információ: A robotépítés jövője.
Előfeltételek
- Ha még nincs Azure-előfizetése, kezdés előtt hozzon létre egy ingyenes fiókot.
- A robot helyi létrehozásának ismerete.
- Bot Framework SDK v4-sablonok Visual Studióhoz (C#), Node.js vagy Yeomanhoz.
Feljegyzés
A sablonokat a Visual Studióban telepítheti.
- A menüben válassza a Bővítmények , majd a Bővítmények kezelése lehetőséget.
- A Bővítmények kezelése párbeszédpanelen keresse meg és telepítse a Bot Framework v4 SDK-sablonokat a Visual Studióhoz.
A .NET-robotok Azure-ban való üzembe helyezésével kapcsolatos információkért tekintse meg a robotok üzembe helyezésének és közzétételének módját.
A minta ismertetése
A cikkben szereplő mintakód egy alapszintű echorobot szerkezetével kezdődik, majd további kód hozzáadásával bővíti a robot funkcióit (alább). Ez a kiterjesztett kód létrehoz egy listát a felhasználói bemenetek fogadásának megőrzéséhez. Minden egyes sor, a memóriába mentett felhasználói bemenetek teljes listája visszakerül a felhasználóra. A bemenetek listáját tartalmazó adatszerkezet ezután módosul a tárolóba való mentéshez. A mintakód további funkciókkal bővíti a tárterület különböző típusait.
Memóriatároló
A Bot Framework SDK lehetővé teszi a felhasználói bemenetek memórián belüli tárolását. Mivel a memóriabeli tárolás minden alkalommal törlődik, amikor a robot újraindul, a legjobban tesztelési célokra alkalmas, és nem éles használatra készült. Az állandó tárolótípusok, például az adatbázis-tárolók az éles robotok számára a legjobbak.
Alapszintű robot létrehozása
A témakör többi része egy Echo-robotból épül fel. Az Echo-robot mintakódja helyileg is létrehozható a robot létrehozásához szükséges rövid útmutatók követésével.
Cserélje le a EchoBot.cs kódját a következő kódra:
using System;
using System.Threading.Tasks;
using Microsoft.Bot.Builder;
using Microsoft.Bot.Schema;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
// Represents a bot saves and echoes back user input.
public class EchoBot : ActivityHandler
{
// Create local Memory Storage.
private static readonly MemoryStorage _myStorage = new MemoryStorage();
// Create cancellation token (used by Async Write operation).
public CancellationToken cancellationToken { get; private set; }
// Class for storing a log of utterances (text of messages) as a list.
public class UtteranceLog : IStoreItem
{
// A list of things that users have said to the bot
public List<string> UtteranceList { get; } = new List<string>();
// The number of conversational turns that have occurred
public int TurnNumber { get; set; } = 0;
// Create concurrency control where this is used.
public string ETag { get; set; } = "*";
}
// Echo back user input.
protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
// preserve user input.
var utterance = turnContext.Activity.Text;
// Make empty local log-items list.
UtteranceLog logItems = null;
// See if there are previous messages saved in storage.
try
{
string[] utteranceList = { "UtteranceLog" };
logItems = _myStorage.ReadAsync<UtteranceLog>(utteranceList).Result?.FirstOrDefault().Value;
}
catch
{
// Inform the user an error occurred.
await turnContext.SendActivityAsync("Sorry, something went wrong reading your stored messages!");
}
// If no stored messages were found, create and store a new entry.
if (logItems is null)
{
// Add the current utterance to a new object.
logItems = new UtteranceLog();
logItems.UtteranceList.Add(utterance);
// Set initial turn counter to 1.
logItems.TurnNumber++;
// Show user new user message.
await turnContext.SendActivityAsync($"{logItems.TurnNumber}: The list is now: {string.Join(", ", logItems.UtteranceList)}");
// Create dictionary object to hold received user messages.
var changes = new Dictionary<string, object>();
{
changes.Add("UtteranceLog", logItems);
}
try
{
// Save the user message to your Storage.
await _myStorage.WriteAsync(changes, cancellationToken);
}
catch
{
// Inform the user an error occurred.
await turnContext.SendActivityAsync("Sorry, something went wrong storing your message!");
}
}
// Else, our storage already contained saved user messages, add new one to the list.
else
{
// add new message to list of messages to display.
logItems.UtteranceList.Add(utterance);
// increment turn counter.
logItems.TurnNumber++;
// show user new list of saved messages.
await turnContext.SendActivityAsync($"{logItems.TurnNumber}: The list is now: {string.Join(", ", logItems.UtteranceList)}");
// Create Dictionary object to hold new list of messages.
var changes = new Dictionary<string, object>();
{
changes.Add("UtteranceLog", logItems);
};
try
{
// Save new list to your Storage.
await _myStorage.WriteAsync(changes,cancellationToken);
}
catch
{
// Inform the user an error occurred.
await turnContext.SendActivityAsync("Sorry, something went wrong storing your message!");
}
}
}
}
A robot indítása
Futtassa helyileg a robotot.
Indítsa el az Emulátort, és csatlakoztassa a robotot
Telepítse a Következő Bot Framework Emulatort , indítsa el az Emulátort, majd csatlakozzon a robothoz az Emulátorban:
- Válassza az Új robotkonfiguráció létrehozása hivatkozást az Emulator Kezdőlapon .
- Töltse ki a robothoz való csatlakozáshoz szükséges mezőket a robot indításakor megjelenő weblapon megjelenő információk alapján.
A robot használata
Küldjön üzenetet a robotnak. A robot felsorolja a kapott üzeneteket.
A cikk további része bemutatja, hogyan menthet állandó tárterületre a robot belső memóriája helyett.
A Cosmos DB használata
Fontos
A Cosmos DB tárolási osztály elavult. Az eredetileg a CosmosDbStorage használatával létrehozott tárolóknak nincs partíciókulcs-készlete, és megkapták a _/partitionKey alapértelmezett partíciókulcsát.
A Cosmos DB-tárolóval létrehozott tárolók particionált Cosmos DB-tárolóval is használhatók. További információért olvassa el a particionálást az Azure Cosmos DB-ben .
Azt is vegye figyelembe, hogy az örökölt Cosmos DB-tárterülettől eltérően a Cosmos DB particionált tároló nem hoz létre automatikusan adatbázist a Cosmos DB-fiókban. Manuálisan kell létrehoznia egy új adatbázist, de hagyja ki manuálisan a tároló létrehozását, mivel a CosmosDbPartitionedStorage létrehozza Önnek a tárolót.
Most, hogy memóriatárolót használt, frissítjük a kódot az Azure Cosmos DB használatára. A Cosmos DB a Microsoft globálisan elosztott, többmodelles adatbázisa. Az Azure Cosmos DB lehetővé teszi, hogy rugalmasan és egymástól függetlenül skálázza az átviteli sebességet és a tárolást az Azure tetszőleges számú földrajzi régiójában. Átviteli sebességet, késést, rendelkezésre állást és konzisztenciát garantál átfogó szolgáltatásiszint-szerződésekkel (SLA-kkal).
Cosmos DB-erőforrás beállítása
A Cosmos DB robotban való használatához létre kell hoznia egy adatbázis-erőforrást, mielőtt a kódba lép. A Cosmos DB-adatbázisok és -alkalmazások létrehozásának részletes leírását a .NET, Node.js vagy Python rövid útmutatójában találhatja meg.
Adatbázisfiók létrehozása
Lépjen az Azure Portalra, és hozzon létre egy Azure Cosmos DB-fiókot. Keresse meg és válassza az Azure Cosmos DB lehetőséget.
Az Azure Cosmos DB lapon válassza az Új lehetőséget az Azure Cosmos DB-fiók létrehozása lap megjelenítéséhez.
Adja meg az alábbi mezők értékeit:
- Előfizetés. Válassza ki az Azure Cosmos-fiókhoz használni kívánt Azure-előfizetést.
- Erőforráscsoport. Válasszon ki egy meglévő erőforráscsoportot, vagy válassza az Új létrehozása lehetőséget, és adjon meg egy nevet egy új erőforráscsoportnak.
- Fióknév. Adjon meg egy nevet az Azure Cosmos-fiók azonosításához. A rendszer a documents.azure.com utótaggal egészíti ki a megadott nevet az URI létrehozásához, ezért válasszon egyedi nevet. Vegye figyelembe a következő irányelveket:
- A névnek egyedinek kell lennie az Azure-ban.
- A névnek 3 és 31 karakter közötti hosszúságúnak kell lennie.
- A név csak kisbetűket, számokat és kötőjelet (-) tartalmazhat.
- API. Core(SQL) kiválasztása
- Hely. válassza ki a felhasználókhoz legközelebb eső helyet, hogy a lehető leggyorsabb hozzáférést biztosítsa számukra az adatokhoz.
Válassza a Felülvizsgálat és létrehozás lehetőséget.
Az ellenőrzés után válassza a Létrehozás lehetőséget.
A fiók létrehozása eltarthat néhány percig. Várjon, amíg a portál megjeleníti a Gratulálunk! Az Azure Cosmos DB-fiók létrehozása lap.
Adatbázis hozzáadása
Feljegyzés
Ne hozza létre saját maga a tárolót. A robot a belső Cosmos DB-ügyfél létrehozásakor hozza létre, biztosítva, hogy megfelelően legyen konfigurálva a robot állapotának tárolásához.
Lépjen az újonnan létrehozott Cosmos DB-fiók Adatkezelő lapjára, majd válassza az Új adatbázis lehetőséget az Új tároló legördülő listából. Ekkor megnyílik egy panel az ablak jobb oldalán, ahol megadhatja az új adatbázis részleteit.
Adjon meg egy azonosítót az új adatbázishoz, és igény szerint állítsa be az átviteli sebességet (ezt később módosíthatja), és végül válassza az OK gombot az adatbázis létrehozásához. Jegyezze fel ezt az adatbázis-azonosítót, hogy később használhassa a robot konfigurálásakor.
Most, hogy létrehozott egy Cosmos DB-fiókot és egy adatbázist, át kell másolnia néhány értéket az új adatbázis robotba való integrálásához. Ezek lekéréséhez lépjen a Cosmos DB-fiók adatbázis-beállítások szakaszában található Kulcsok lapra. Ezen a lapon szüksége lesz az URI-ra (Cosmos DB-végpont) és az ELSŐDLEGES KULCSra (engedélyezési kulcs).
Most már rendelkeznie kell egy Cosmos DB-fiókkal, amely rendelkezik adatbázissal és a robotbeállításokban használható alábbi értékekkel.
- URI
- Elsődleges kulcs
- Adatbázis-azonosító
Cosmos DB konfigurációs adatainak hozzáadása
Használja a cikk előző részében jegyzett részleteket a végpont, az engedélyezési kulcs és az adatbázis-azonosító beállításához. Végül meg kell adnia egy megfelelő nevet annak a tárolónak, amelyet az adatbázison belül hoz létre a robot állapotának tárolásához. Az alábbi példában a létrehozott Cosmos DB-tároló neve "bot-storage".
Adja hozzá a következő adatokat a konfigurációs fájlhoz.
appsettings.json
"CosmosDbEndpoint": "<your-CosmosDb-URI>",
"CosmosDbAuthKey": "<your-primary-key>",
"CosmosDbDatabaseId": "<your-database-id>",
"CosmosDbContainerId": "bot-storage"
Cosmos DB-csomagok telepítése
Győződjön meg arról, hogy a Cosmos DB-hez szükséges csomagokat használja.
Telepítse a Microsoft.Bot.Builder.Azure NuGet csomagot. További információ a NuGet használatáról: Csomagok telepítése és kezelése a Visual Studióban a NuGet Csomagkezelő használatával.
Cosmos DB implementálása
Feljegyzés
A 4.6-os verzió bevezetett egy új Cosmos DB-tárolószolgáltatót, a Cosmos DB particionált tárolási osztályt, és az eredeti Cosmos DB tárolási osztály elavult. A Cosmos DB-tárolóval létrehozott tárolók particionált Cosmos DB-tárolóval is használhatók. További információért olvassa el a particionálást az Azure Cosmos DB-ben .
Az örökölt Cosmos DB-tárolótól eltérően a Cosmos DB particionált tároló nem hoz létre automatikusan adatbázist a Cosmos DB-fiókban. Manuálisan kell létrehoznia egy új adatbázist, de hagyja ki manuálisan a tároló létrehozását, mivel a CosmosDbPartitionedStorage létrehozza Önnek a tárolót.
A következő mintakód ugyanazzal a robotkóddal fut, mint a fent megadott memóriatárolási minta, az itt felsorolt kivételekkel. Az alábbi kódrészletek a Cosmos DB storage implementációját mutatják be a "myStorage" számára, amely a helyi memóriatárolót helyettesíti.
Először frissítenie kell Startup.cs a robotszerkesztő Azure-kódtárára való hivatkozáshoz:
using Microsoft.Bot.Builder.Azure;
Ezután a ConfigureServices
Startup.cs metódusában hozza létre az CosmosDbPartitionedStorage
objektumot. Ezt függőséginjektálással továbbítja a EchoBot
konstruktornak.
// Use partitioned CosmosDB for storage, instead of in-memory storage.
services.AddSingleton<IStorage>(
new CosmosDbPartitionedStorage(
new CosmosDbPartitionedStorageOptions
{
CosmosDbEndpoint = Configuration.GetValue<string>("CosmosDbEndpoint"),
AuthKey = Configuration.GetValue<string>("CosmosDbAuthKey"),
DatabaseId = Configuration.GetValue<string>("CosmosDbDatabaseId"),
ContainerId = Configuration.GetValue<string>("CosmosDbContainerId"),
CompatibilityMode = false,
}));
A EchoBot.cs módosítsa a _myStorage
változódeklarációt private static readonly MemoryStorage _myStorage = new MemoryStorage();
a következőre:
// variable used to save user input to CosmosDb Storage.
private readonly IStorage _myStorage;
Ezután adja át az IStorage
objektumot a EchoBot
konstruktornak:
public EchoBot(IStorage storage)
{
if (storage is null) throw new ArgumentNullException();
_myStorage = storage;
}
A Cosmos DB-robot indítása
Futtassa helyileg a robotot.
Cosmos DB-robot tesztelése a Bot Framework Emulator használatával
Indítsa el a Bot Framework Emulatort, és csatlakozzon a robothoz:
- Válassza az Új robotkonfiguráció létrehozása hivatkozást az Emulator Üdvözlőlapon .
- Töltse ki a robothoz való csatlakozáshoz szükséges mezőket a robot indításakor megjelenő weblapon megjelenő információk alapján.
A Cosmos DB-robot használata
Küldjön üzenetet a robotnak, és a robot felsorolja a kapott üzeneteket.
Cosmos DB-adatok megtekintése
Miután futtatta a robotot, és mentette az adatokat, megtekintheti az Azure Portalon tárolt adatokat az Adatkezelő lapon.
Blob Storage használata
Az Azure Blob Storage a Microsoft felhőalapú objektumtárolási megoldása. A Blob Storage nagy mennyiségű strukturálatlan adat, például szöveg vagy bináris adatok tárolására van optimalizálva. Ez a szakasz bemutatja, hogyan hozhat létre Azure Blob Storage-fiókot és -tárolót, majd hogyan hivatkozhat a blobtároló tárolójára a robotból.
További információ a Blob Storage-ról: Mi az Az Azure Blob Storage?
Blob Storage-fiók létrehozása
Ha blobtárolót szeretne használni a robotban, be kell állítania néhány dolgot, mielőtt belefogad a kódba.
Az Azure Portalon válassza a Minden szolgáltatás elemet.
A Minden szolgáltatás lap Kiemelt szakaszában válassza a Tárfiókok lehetőséget.
A Tárfiókok lapon válassza az Új lehetőséget.
Az Előfizetés mezőben válassza ki azt az előfizetést, amelyben létre szeretné hozni a tárfiókot.
Az Erőforráscsoport mezőben válasszon ki egy meglévő erőforráscsoportot, vagy válassza az Új létrehozása lehetőséget, és adja meg az új erőforráscsoport nevét.
A Tárfiók neve mezőben adja meg a fiók nevét. Vegye figyelembe a következő irányelveket:
- A névnek egyedinek kell lennie az Azure-ban.
- A névnek 3 és 24 karakter közötti hosszúságúnak kell lennie.
- A név csak számokat és kisbetűket tartalmazhat.
A Hely mezőben válassza ki a tárfiók helyét, vagy használja az alapértelmezett helyet.
A többi beállításnál konfigurálja a következőket:
- Teljesítmény: Standard. További információ a teljesítményről.
- Fiók típusa: BlobStorage. További információ a tárfiókokról.
- Replikáció: Hagyja meg az alapértelmezett beállítást. További információ a redundanciáról.
A Tárfiók létrehozása lap Projekt részletei szakaszában válassza ki az előfizetés és az erőforráscsoport kívánt értékeit.
A Tárfiók létrehozása lap Példány részletei szakaszában adja meg a Tárfiók nevét, majd válassza ki a Hely, a Fiók típusa és a Replikáció értéket.
Válassza a Felülvizsgálat + létrehozás lehetőséget a tárfiók beállításainak áttekintéséhez.
Az ellenőrzés után válassza a Létrehozás lehetőséget.
Blob Storage-tároló létrehozása
A Blob Storage-fiók létrehozása után nyissa meg, majd:
Válassza a Storage Explorer (előzetes verzió) lehetőséget.
Ezután kattintson a jobb gombbal a BLOB-TÁROLÓkra
Válassza a Blob-tároló létrehozása lehetőséget a legördülő listából.
Adjon meg egy nevet az Új tároló űrlapon. Ezt a nevet fogja használni a "blobtároló neve" értékéhez, hogy hozzáférést biztosítson a Blob Storage-fiókhoz. Vegye figyelembe a következő irányelveket:
- Ez a név csak kisbetűket, számokat és kötőjeleket tartalmazhat.
- Ennek a névnek betűvel vagy számmal kell kezdődnie.
- Minden kötőjelet meg kell előznie, és egy érvényes, nem kötőjel karakternek kell követnie.
- A névnek 3 és 63 karakter közötti hosszúságúnak kell lennie.
Blob Storage konfigurációs adatainak hozzáadása
Keresse meg a Blob Storage robothoz való konfigurálásához szükséges Blob Storage-kulcsokat a fent látható módon:
- Nyissa meg a Blob Storage-fiókot az Azure Portalon, és válassza a Hozzáférési kulcsokat a Beállítások szakaszban.
- Ha úgy szeretné konfigurálni a robotot, hogy hozzáférjen a Blob Storage-fiókhoz, használja a kapcsolati sztringet a blob kapcsolati sztring értékeként.
Adja hozzá a következő adatokat a konfigurációs fájlhoz.
appsettings.json
"BlobConnectionString": "<your-blob-connection-string>",
"BlobContainerName": "<your-blob-container-name>",
Blob Storage-csomagok telepítése
Ha korábban nem telepítette, telepítse a következő csomagokat.
Telepítse a Microsoft.Bot.Builder.Azure.Blobs NuGet csomagot. További információ a NuGet használatáról: Csomagok telepítése és kezelése a Visual Studióban a NuGet Csomagkezelő használatával.
A Blob Storage implementálása
A Blob Storage a robot állapotának tárolására szolgál.
Feljegyzés
A 4.10-es Microsoft.Bot.Builder.Azure.AzureBlobStorage
verzió elavult. Használja az újat Microsoft.Bot.Builder.Azure.Blobs.BlobsStorage
a helyén.
A következő mintakód ugyanazzal a robotkóddal fut, mint a fent megadott memóriatárolási minta, az itt felsorolt kivételekkel.
Az alábbi kódrészletek a "myStorage" Blob Storage implementációját mutatják be, amely felváltja a helyi memóriatárolót.
Először frissítenie kell Startup.cs a robotszerkesztő Azure Blobs-kódtárára való hivatkozáshoz:
Startup.cs
using Microsoft.Bot.Builder.Azure.Blobs;
Ezután a ConfigureServices
Startup.cs metódusában hozza létre az BlobsStorage
objektumot, és adja át az értékeket a következőbőlappsettings.json
: . Ezt függőséginjektálással továbbítja a EchoBot
konstruktornak.
//Use Azure Blob storage, instead of in-memory storage.
services.AddSingleton<IStorage>(
new BlobsStorage(
Configuration.GetValue<string>("BlobConnectionString"),
Configuration.GetValue<string>("BlobContainerName")
));
Most először frissítenie kell EchoBot.cs a robotszerkesztő Azure Blobs-kódtárára való hivatkozáshoz:
EchoBot.cs
using Microsoft.Bot.Builder.Azure.Blobs;
Ezután távolítsa el vagy fűzzön megjegyzést a "private static readonly MemoryStorage _myStorage = new MemoryStorage();" nevű MemoryStorage változót létrehozó kódsorhoz, és hozzon létre egy új változót, amely a felhasználói bemenet blobtárolóba való mentésére szolgál.
EchoBot.cs
// variable used to save user input to CosmosDb Storage.
private readonly IStorage _myStorage;
Ezután adja át az IStorage
objektumot a EchoBot
konstruktornak:
public EchoBot(IStorage storage)
{
if (storage is null) throw new ArgumentNullException();
_myStorage = storage;
}
Miután a tárterület a Blob Storage-fiókra lett állítva, a robot kódja mostantól tárolja és lekéri az adatokat a Blob Storage-ból.
Miután a tárterület a Blob Storage-fiókra lett állítva, a robot kódja mostantól tárolja és lekéri az adatokat a Blob Storage-ból.
A Blob Storage-robot indítása
Futtassa helyileg a robotot.
Indítsa el az Emulatort, és csatlakoztassa a Blob Storage-robotot
Ezután indítsa el az Emulátort, majd csatlakozzon a robothoz az Emulátorban:
- Válassza az Új robotkonfiguráció létrehozása hivatkozást az Emulátor "Üdvözli" lapján.
- Töltse ki a robothoz való csatlakozáshoz szükséges mezőket a robot indításakor megjelenő weblapon megjelenő információk alapján.
A Blob Storage-robot használata
Küldjön üzenetet a robotnak, és a robot felsorolja a kapott üzeneteket.
Blob Storage-adatok megtekintése
Miután futtatta a robotot, és mentette az adatokat, azOkat az Azure Portal Storage Explorer lapján tekintheti meg.
Blob átirattároló
Az Azure Blob Transcript Storage speciális tárolási lehetőséget biztosít, amellyel egyszerűen mentheti és lekérheti a felhasználói beszélgetéseket rögzített átirat formájában. Az Azure Blob-átiratok tárolása hasznos a felhasználói bemenetek automatikus rögzítéséhez a robot teljesítményének hibakeresése során.
Feljegyzés
A Python jelenleg nem támogatja az Azure Blob-átiratok tárolását. Bár a JavaScript támogatja a Blob-átiratok tárolását, az alábbi útmutatás csak C# esetén érhető el.
Blob átirattároló beállítása
Az Azure Blob-átirattár a fenti "A Blob Storage-fiók létrehozása" és a "Konfigurációs adatok hozzáadása" című szakasz lépéseit követve használhatja ugyanazt a blobtároló-fiókot, amelyet létrehozott. Most hozzáadunk egy tárolót az átirataink tárolásához
- Nyissa meg az Azure Blob Storage-fiókját.
- Válassza a Storage Explorer lehetőséget.
- Kattintson a jobb gombbal a BLOB-TÁROLÓk elemre, és válassza a Blob-tároló létrehozása lehetőséget.
- Adja meg az átirattároló nevét, majd kattintson az OK gombra. (Beírtuk a mybottranscripteket)
Blob átirattároló implementálása
Az alábbi kód az átirattár mutatóját _myTranscripts
az új Azure Blob-átirat tárfiókhoz köti. Ha ezt a hivatkozást egy új tárolónévvel, <az Ön-blob-transcript-container-name> névvel szeretné létrehozni, létrehoz egy új tárolót a Blob Storage-on belül az átiratfájlok tárolásához.
A Blob-átiratok tárolása robotok átiratainak tárolására szolgál.
Feljegyzés
A 4.10-es Microsoft.Bot.Builder.Azure.AzureBlobTranscriptStore
verzió elavult. Használja az újat Microsoft.Bot.Builder.Azure.Blobs.BlobsTranscriptStore
a helyén.
echoBot.cs
using Microsoft.Bot.Builder.Azure.Blobs;
public class EchoBot : ActivityHandler
{
...
private readonly BlobsTranscriptStore _myTranscripts = new BlobsTranscriptStore("<your-azure-storage-connection-string>", "<your-blob-transcript-container-name>");
...
}
Felhasználói beszélgetések tárolása Az Azure Blob-átiratokban
Miután egy blobtároló elérhetővé válik az átiratok tárolásához, megkezdheti a felhasználói beszélgetések megőrzését a robottal. Ezek a beszélgetések később hibakeresési eszközként is használhatók annak megtekintéséhez, hogy a felhasználók hogyan használják a robotot. Minden Emulator-újraindítási beszélgetés egy új átiratos beszélgetési lista létrehozását kezdeményezi. Az alábbi kód megőrzi a felhasználói beszélgetések bemeneteit egy tárolt átiratfájlban.
- Az aktuális átirat mentése a következővel történik
LogActivityAsync
: . - A mentett átiratok lekérése a következővel történik
ListTranscriptsAsync
: . Ebben a mintakódban az egyes tárolt átiratok azonosítója egy "storedTranscripts" nevű listába lesz mentve. Ez a lista később a tárolt blobok átiratainak számának kezelésére szolgál.
echoBot.cs
protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
await _myTranscripts.LogActivityAsync(turnContext.Activity);
List<string> storedTranscripts = new List<string>();
PagedResult<Microsoft.Bot.Builder.TranscriptInfo> pagedResult = null;
var pageSize = 0;
do
{
pagedResult = await _myTranscripts.ListTranscriptsAsync("emulator", pagedResult?.ContinuationToken);
pageSize = pagedResult.Items.Count();
// transcript item contains ChannelId, Created, Id.
// save the channelIds found by "ListTranscriptsAsync" to a local list.
foreach (var item in pagedResult.Items)
{
storedTranscripts.Add(item.Id);
}
} while (pagedResult.ContinuationToken != null);
...
}
Tárolt blobok átiratainak kezelése
Bár a tárolt átiratok hibakeresési eszközként is használhatók, idővel a tárolt átiratok száma nagyobb lehet, mint amennyit meg szeretne őrizni. Az alábbi további kód az összes, az utolsó három lekért átirati elem eltávolítására szolgál DeleteTranscriptAsync
a blob átirattárolójából.
echoBot.cs
protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
{
await _myTranscripts.LogActivityAsync(turnContext.Activity);
List<string> storedTranscripts = new List<string>();
PagedResult<Microsoft.Bot.Builder.TranscriptInfo> pagedResult = null;
var pageSize = 0;
do
{
pagedResult = await _myTranscripts.ListTranscriptsAsync("emulator", pagedResult?.ContinuationToken);
pageSize = pagedResult.Items.Count();
// transcript item contains ChannelId, Created, Id.
// save the channelIds found by "ListTranscriptsAsync" to a local list.
foreach (var item in pagedResult.Items)
{
storedTranscripts.Add(item.Id);
}
} while (pagedResult.ContinuationToken != null);
// Manage the size of your transcript storage.
for (int i = 0; i < pageSize; i++)
{
// Remove older stored transcripts, save just the last three.
if (i < pageSize - 3)
{
string thisTranscriptId = storedTranscripts[i];
try
{
await _myTranscripts.DeleteTranscriptAsync("emulator", thisTranscriptId);
}
catch (System.Exception ex)
{
await turnContext.SendActivityAsync("Debug Out: DeleteTranscriptAsync had a problem!");
await turnContext.SendActivityAsync("exception: " + ex.Message);
}
}
}
...
}
Az osztályról további információt az Azure Blob Transcript Storage-ban talál.
További információ
Egyidejűség kezelése eTags használatával
A robotkód példájában mindegyik IStoreItem
tulajdonságát eTag
a következőre *
állítjuk be: . Az eTag
áruházobjektum (entitáscímke) tagját a Cosmos DB használja az egyidejűség kezelésére. Ez eTag
azt jelzi az adatbázisnak, hogy mi a teendő, ha a robot egy másik példánya ugyanabban a tárolóban módosította az objektumot, amelybe a robot ír.
Az utolsó írás nyer – felülírás engedélyezése
A eTag
csillag (*
) tulajdonságértéke azt jelzi, hogy az utolsó író nyer. Új adattár létrehozásakor beállíthat egy tulajdonságot eTag
*
, amely jelzi, hogy korábban nem mentette az éppen írt adatokat, vagy azt szeretné, hogy az utolsó író felülírja a korábban mentett tulajdonságokat. Ha az egyidejűség nem jelent problémát a robot számára, a tulajdonság *
írása lehetővé teszi a eTag
felülírást.
Egyidejűség fenntartása és felülírás megakadályozása
Amikor az adatokat a Cosmos DB-be tárolja, használjon a tulajdonsághoz való egyidejű hozzáféréstől eltérő *
eTag
értéket, és kerülje a robot egy másik példányának módosításainak felülírását. A robot hibaüzenetet kap az üzenettel etag conflict key=
, amikor állapotadatokat próbál menteni, és nem eTag
ugyanaz az érték, mint a eTag
tárolóban.
Alapértelmezés szerint a Cosmos DB-tároló minden alkalommal ellenőrzi a eTag
tárolóobjektum tulajdonságát, hogy a robot minden alkalommal egyenlőséget biztosít-e, amikor egy robot ír az adott elemre, majd minden írás után egy új egyedi értékre frissíti azt. Ha az eTag
írási tulajdonság nem egyezik a eTag
tárolóban lévő tulajdonságtal, az azt jelenti, hogy egy másik robot vagy szál módosította az adatokat.
Tegyük fel például, hogy azt szeretné, hogy a robot szerkessze a mentett jegyzetet, de nem szeretné, hogy a robot felülírja a robot egy másik példányának módosításait. Ha a robot egy másik példánya végzett módosításokat, azt szeretné, hogy a felhasználó a legújabb frissítésekkel szerkessze a verziót.
Először hozzon létre egy implementálható osztályt IStoreItem
.
EchoBot.cs
public class Note : IStoreItem
{
public string Name { get; set; }
public string Contents { get; set; }
public string ETag { get; set; }
}
Ezután hozzon létre egy kezdeti megjegyzést egy tárobjektum létrehozásával, és adja hozzá az objektumot a tárolóhoz.
EchoBot.cs
// create a note for the first time, with a non-null, non-* ETag.
var note = new Note { Name = "Shopping List", Contents = "eggs", ETag = "x" };
var changes = Dictionary<string, object>();
{
changes.Add("Note", note);
};
await NoteStore.WriteAsync(changes, cancellationToken);
Ezután később érheti el és frissítheti a jegyzetet, megtartva azt eTag
, amelyet az áruházból olvas.
EchoBot.cs
var note = NoteStore.ReadAsync<Note>("Note").Result?.FirstOrDefault().Value;
if (note != null)
{
note.Contents += ", bread";
var changes = new Dictionary<string, object>();
{
changes.Add("Note1", note);
};
await NoteStore.WriteAsync(changes, cancellationToken);
}
Ha a megjegyzést a módosítások írása előtt frissítették az áruházban, a hívás kivételt fog eredményezni Write
.
Az egyidejűség fenntartásához mindig olvasson be egy tulajdonságot a tárolóból, majd módosítsa az olvasott tulajdonságot, hogy az eTag
megmaradjon. Ha felhasználói adatokat olvas az áruházból, a válasz tartalmazza az eTag tulajdonságot. Ha módosítja az adatokat, és frissített adatokat ír az áruházba, a kérésnek tartalmaznia kell az eTag tulajdonságot, amely ugyanazt az értéket adja meg, mint amelyet korábban olvasott. Ha azonban olyan objektumot ír, amelynek a készlete eTag
*
lehetővé teszi, hogy az írás felülírja a többi módosítást.
Következő lépések
Most, hogy már tudja, hogyan olvashat és írhat közvetlenül a tárolóból, áttekintheti, hogyan használhatja ezt az állapotkezelőt.