注意
このチュートリアルでは、 セマンティック カーネルC#ライブラリ を使用します。Pythonライブラリを使用するチュートリアルについては、セマンティック カーネルPython統合を使い始める を参照してください。
MongoDB ベクトル検索 をMicrosoftセマンティック カーネルと統合して、 AIアプリケーションを構築し、検索拡張生成 (RAG)(RAG) を実装できます。このチュートリアルでは、セマンティック カーネルとともにMongoDB ベクトル検索を使用してデータに対してセマンティック検索を実行し、RAG実装を構築する方法を説明します。具体的には、次のアクションを実行します。
環境を設定します。
カスタム データをMongoDBに保存します。
データにMongoDB ベクトル検索インデックスを作成します。
データに対してセマンティック検索クエリを実行します。
MongoDB ベクトル検索を使用してデータの質問に答え、RAG を実装します。
バックグラウンド
セマンティック カーネルは、アプリケーションでさまざまな AI サービスとプラグインを組み合わせることができるオープンソースの SDK です。 セマンティック カーネルは、 RAGを含むさまざまな AI ユースケースに使用できます。
MongoDB ベクトル検索 と Semantic Kernel を統合することで、MongoDB をベクトルデータベースとして利用し、MongoDB ベクトル検索 を使用して、データから意味的に類似したドキュメントを検索し、RAG を実装することができます。RAG の詳細については、「MongoDB による検索拡張生成(RAG)」を参照してください。
前提条件
Atlas の サンプル データ セット からの映画データを含むコレクションを使用します。
次のいずれかのMongoDBクラスター タイプ
MongoDB バージョン 6.0.11 を実行している Atlas クラスター、7.0.2以降。IP アドレスが Atlas プロジェクトのアクセスリストに含まれていることを確認します。
Python と Docker を使用して作成されたローカル Atlas 配置。
atlas-local-lib-py(pip install atlas-local-lib-py) をインストールして、ローカル配置をプログラムで作成および管理します。詳細については、atlas-local-lib-py リポジトリを参照してください。検索とベクトル検索がインストールされた MongoDB Community クラスター。
OpenAI APIキー。APIリクエストに使用できるクレジットを持つ OpenAI アカウントが必要です。OpenAI アカウントの登録の詳細については、OpenAI APIウェブサイト を参照してください。
.NET アプリケーションを実行するためのターミナルとコード エディター。
C#/ .NETがインストールされました。
環境を設定する
最初に、このチュートリアルの環境を設定する必要があります。 環境を設定するには、次の手順を実行します。
依存関係をインストールします。
このチュートリアルのパッケージをインストールするには、ターミナルで次のコマンドを実行します。
dotnet add package Microsoft.SemanticKerneldotnet add package Microsoft.SemanticKernel.Connectors.MongoDB --prereleasedotnet add package Microsoft.SemanticKernel.Connectors.OpenAIdotnet add package Microsoft.Extensions.AIdotnet add package Microsoft.Extensions.AI.OpenAIdotnet add package Microsoft.Extensions.AI.Abstractionsdotnet add package Microsoft.Extensions.VectorData.Abstractionsdotnet add package SemanticKernelPooling.Connectors.OpenAI環境変数を定義してください。
ターミナルで次のコマンドを実行して、 MongoDBクラスターの SRV 接続文字列 と OpenAI APIキー を環境に追加します。
export OPENAI_API_KEY="<Your OpenAI API Key>"export MONGODB_URI="<Your MongoDB Atlas SRV Connection String>"注意
<connection-string> を Atlas クラスターまたはローカル Atlas 配置の接続文字列に置き換えます。
接続stringには、次の形式を使用する必要があります。
mongodb+srv://<db_username>:<db_password>@<clusterName>.<hostname>.mongodb.net重要:接続文字列にデータベースユーザーの認証情報が含まれていることを確認します。接続文字列の検索方法の詳細については、クライアント ライブラリ経由でクラスターに接続する を参照してください。
接続stringには、次の形式を使用する必要があります。
mongodb://localhost:<port-number>/?directConnection=true詳細については、「接続文字列 」を参照してください。
MongoDBでカスタム データを保存する
このセクションでは、アプリケーションのサービスとプラグインを管理するために使用されるメインのインターフェースであるカーネルを初期化します。カーネルを介して、 AIサービスを構成し、 MongoDB をベクトルデータベース(メモリストアとも)としてインスタンス化し、カスタム データをMongoDBクラスターにロードします。
次のコードをコピーして、アプリケーションのProgram.csファイルに貼り付けます。
このコードは、次のアクションを実行します。
セマンティック カーネルとすべての必要なパッケージをインポートします。
環境から AtlasSRV 接続文字列 を取得して クラスターに接続します。
環境から OpenAI API キーを検索し、OpenAI の
text-embedding-ada-002埋め込みモデルのインスタンスを作成します。Atlas をメモリ ストアとしてインスタンス化し、次のパラメータを指定します。
semantic_kernel_db.recordsドキュメントを保存するコレクションとして。vector_indexメモリ ストアをクエリするために使用するインデックスとして。
CreateCollectionFromListAsyncメソッドを呼び出して、semantic_kernel_db.recordsコレクションにサンプル ドキュメントを入力します。semantic_kernel_db.recordsコレクションを含む変数recordCollectionを定義します。メモリにテキストを保存および検索するための 2 つのヘルパーメソッドを作成します。
CreateRecord: 新しいDataModelオブジェクトを作成するファクトリー。CreateCollectionFromListAsync: string エントリを取得し、string の埋め込みを生成し、対応するレコードを作成し、それらのレコードを Atlas クラスターのコレクションにアップサートする方法。
MongoDBコレクションに保存されるドキュメントの構造を定義する
DataModelクラスを作成します。
using Microsoft.Extensions.AI;using Microsoft.Extensions.VectorData;using Microsoft.SemanticKernel.Connectors.MongoDB;using Microsoft.SemanticKernel.Data;using MongoDB.Bson;using MongoDB.Driver;using OpenAI;
#pragma warning disable SKEXP0001
static class Program{ static async Task Main(string[] args) { // Get connection string and OpenAI API Key var connectionString = Environment.GetEnvironmentVariable("MONGODB_URI"); if (connectionString == null) { Console.WriteLine("You must set your 'MONGODB_URI' environment variable."); Environment.Exit(0); }
var openAIKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY"); if (openAIKey == null) { Console.WriteLine("You must set your 'OPENAPI_KEY' environment variable."); Environment.Exit(0); }
// Create new OpenAI API Embedding Model var embeddingGenerator = new OpenAIClient(openAIKey) .GetEmbeddingClient("text-embedding-ada-002") .AsIEmbeddingGenerator();
// Instantiate MongoDB as a vector store var mongoClient = new MongoClient(connectionString); var options = new MongoVectorStoreOptions { EmbeddingGenerator = embeddingGenerator }; var vectorStore = new MongoVectorStore(mongoClient.GetDatabase("semantic_kernel_db"), options);
// Sample data string[] lines = [ "I am a developer", "I started using MongoDB two years ago", "I'm using MongoDB Vector Search with Semantic Kernel to implement RAG", "I like coffee" ];
// Populate database with sample data await CreateCollectionFromListAsync<string, DataModel>(vectorStore, "records", lines, embeddingGenerator, CreateRecord); // Get the specific collection from the vector store var recordCollection = vectorStore.GetCollection<string, DataModel>("records"); }
static DataModel CreateRecord(string text, ReadOnlyMemory<float> embedding) => new() { Key = ObjectId.GenerateNewId().ToString(), Text = text, Embedding = embedding };
static async Task CreateCollectionFromListAsync<TKey, TRecord>( this VectorStore vectorStore, string collectionName, string[] entries, IEmbeddingGenerator<string, Embedding<float>> embeddingGenerator, Func<string, ReadOnlyMemory<float>, TRecord> createRecord) where TKey : notnull where TRecord : class { // Get and create collection if it doesn't exist var collection = vectorStore.GetCollection<TKey, TRecord>(collectionName); await collection.EnsureCollectionExistsAsync().ConfigureAwait(false);
// Create records and generate embeddings for them var embeddings = await embeddingGenerator.GenerateAsync(entries); var records = entries.Zip(embeddings, (entry, embedding) => createRecord(entry, embedding.Vector));
// Add them to the database await collection.UpsertAsync(records).ConfigureAwait(false); }
internal sealed class DataModel { [VectorStoreKey] [TextSearchResultName] public required String Key { get; init; }
[VectorStoreData] [TextSearchResultValue] public required string Text { get; init; }
[VectorStoreVector(1536)] public ReadOnlyMemory<float> Embedding { get; init; } }}ファイルを保存し、次のコマンドを実行してデータをMongoDBにロードします。
dotnet runTip
Atlassemantic_kernel_db.test を使用している場合は、サンプルコードの実行中後、Atlas UIの 名前空間に移動することでベクトル埋め込みを検証できます。
ベクトル検索クエリの実行
ベクトル埋め込みを作成したら、データに対してベクトル検索クエリを実行できます。
Program.csファイルの Programクラスの末尾に、文字列 What is my job title? の基本的なセマンティック検索を実行するための次のコードを追加します。 最も関連性の高いドキュメントが出力されます。
// Create a text search instance using the InMemory vector store.var textSearch = new VectorStoreTextSearch<DataModel>(recordCollection, embeddingGenerator);
// Search and return results as TextSearchResult itemsvar query = "What is my job title?";KernelSearchResults<TextSearchResult> textResults = await textSearch.GetTextSearchResultsAsync(query, new() { Top = 2, Skip = 0 });await foreach (TextSearchResult result in textResults.Results){ Console.WriteLine($"Answer: {result.Value}");}Console.WriteLine("Search completed.");ファイルを保存し、次のコマンドを実行して、セマンティック検索の結果を確認します。
dotnet runAnswer: I am a developerSearch completed.データに関する質問に答えます
このセクションでは、MongoDB ベクトル検索と Semantic Kernel を使用した RAG の実装例を示します。MongoDB ベクトル検索を使用して意味的に類似したドキュメントを検索したので、Program.cs の Program クラスの末尾に次の例を貼り付け、これらのドキュメントに基づいて質問に答えるよう LLM にプロンプトを送信します。
このコードは、次のアクションを実行します。
OpenAI の
gpt-4oをチャットモデルとして応答を生成するための新しいカーネルを作成します。ベクトルストアを使用して新しいテキスト検索インスタンスを作成します。
チャット モデルに質問するための質問を定義し、変数
retrievedContextを初期化してベクトルストアのコンテキストを保持します。recordCollectionでWhen did I start using MongoDB?のセマンティック検索を実行し、最も関連性の高い検索結果を返します。検索されたコンテキストのみに基づいて質問に応答するようAIモデルに指示するプロンプト テンプレートを構築します。
カーネルの
CreateFunctionFromPrompt関数を使用して、チャット プロンプトからragFunctionという名前の関数を作成します。質問とコンテキストを保持するための新しいオブジェクトを作成して、RG プロンプトの引数を準備します。
カーネルの
InvokeAsync関数を呼び出して、次のパラメータを使用してチャット モデルから応答を生成します。プロンプト テンプレートを構成する
ragFunction。質問とコンテキストを含む
ragArguments。
質問と生成された応答を出力します。
// Create a kernel with OpenAI chat completionIKernelBuilder kernelBuilder = Kernel.CreateBuilder();kernelBuilder.AddOpenAIChatCompletion( modelId: "gpt-4o", apiKey: openAIKey);Kernel kernel = kernelBuilder.Build();
// Create a text search instance using the vector store collection.var textSearch = new VectorStoreTextSearch<DataModel>(recordCollection, embeddingGenerator);
// --- Modified RAG Section ---var userQuestion = "When did I start using MongoDB?";string retrievedContext = "No relevant context found."; // Default
// 1. Perform search to get contextvar searchResults = await textSearch.GetTextSearchResultsAsync(userQuestion, new() { Top = 1 }); // Get most relevant result
await foreach (var result in searchResults.Results){ if (result.Value != null) { retrievedContext = result.Value; // Use the text from the search result as context break; // Take the most relevant result }}
// 2. Define a prompt template that uses the retrieved contextconst string ragPromptTemplate = @"Context:{{$context}}
Question:{{$question}}
Based *only* on the context provided, answer the question.Answer:";
// 3. Create a function from the RAG prompt templatevar ragFunction = kernel.CreateFunctionFromPrompt(ragPromptTemplate);
// 4. Prepare arguments for the RAG promptvar ragArguments = new KernelArguments{ ["question"] = userQuestion, ["context"] = retrievedContext};
// 5. Invoke the RAG promptvar ragResult = await kernel.InvokeAsync(ragFunction, ragArguments);
Console.WriteLine($"Question: {userQuestion}");Console.WriteLine($"Retrieved Context: {retrievedContext}");Console.WriteLine($"Answer: {ragResult.GetValue<string>()}");// --- End of Modified RAG Section ---ファイルを保存し、次のコマンドを実行して応答を生成します。
dotnet runQuestion: When did I start using MongoDB?Retrieved Context: I started using MongoDB two years agoAnswer: Two years ago.Tip
独自のデータを追加し、コードの次の部分を置き換えると、別の質問に対する応答を生成できます。
var userQuestion = "When did I start using MongoDB?"
次のステップ
MongoDBは、次の開発者リソースも提供しています。