セマンティック カーネル C# 統合を使い始める
注意
このチュートリアルでは、セマンティック カーネル C# ライブラリ を使用します。 。Python ライブラリを使用するチュートリアルについては、「 セマンティック カーネル Python 統合を使い始める 」を参照してください。
Atlas Vector Search を Microsoft セマンティック カーネル と統合できます AI アプリケーションを構築し、検索拡張生成(RAG)を実装します。このチュートリアルでは、セマンティック カーネルと Atlas Vector Search の使用を開始し、データに対してセマンティック検索を実行し、 RAG実装を構築する方法を説明します。 具体的には、次のアクションを実行します。
環境を設定します。
カスタム データを Atlas に保存します。
データに Atlas Vector Search インデックスを作成します。
データに対してセマンティック検索クエリを実行します。
Atlas Vector Search を使用してデータの質問に答え、RAG を実装します。
バックグラウンド
セマンティック カーネルは、アプリケーションでさまざまな AI サービスとプラグインを組み合わせることができるオープンソースの SDK です。 セマンティック カーネルは、 RAGを含むさまざまな AI ユースケースに使用できます。
Atlas Vector Searchをセマンティック カーネルと統合することで、 Atlasをベクトルデータベースとして使用し、 Atlas Vector Searchを使用してセマンティックで類似したドキュメントを検索してRAGを実装することができます。 RAGRGRAG Atlas Vector Searchの詳細については、「 による検索拡張生成( ) 」を してください。
前提条件
Atlas の サンプル データ セット からの映画データを含むコレクションを使用します。
Atlas アカウントで、MongoDB バージョン 6.0.11 または7.0.2 以降(RCs を含む)のクラスターを実行している。IP アドレスが Atlas プロジェクトのアクセスリストに含まれていることを確認してください。詳細については、クラスターの作成を参照してください。
OpenAI API キー。API リクエストに使用できるクレジットを持つ OpenAI アカウントが必要です。OpenAI アカウントの登録について詳しく知りたい場合は、 OpenAI API ウェブサイトをご覧ください。
.NET アプリケーションを実行するためのターミナルとコード エディター。
C#/.NET インストール済み。
環境を設定する
最初に、このチュートリアルの環境を設定する必要があります。 環境を設定するには、次の手順を実行します。
依存関係をインストールします。
このチュートリアルのパッケージをインストールするには、ターミナルで次のコマンドを実行します。
dotnet add package Microsoft.SemanticKernel dotnet add package Microsoft.SemanticKernel.Connectors.MongoDB --prerelease dotnet add package Microsoft.SemanticKernel.Connectors.OpenAI dotnet add package Microsoft.Extensions.AI dotnet add package Microsoft.Extensions.AI.OpenAI dotnet add package Microsoft.Extensions.AI.Abstractions dotnet add package Microsoft.Extensions.VectorData.Abstractions dotnet add package SemanticKernelPooling.Connectors.OpenAI
環境変数を定義してください。
ターミナルで次のコマンドを実行して、 AtlasクラスターのSRV接続文字列と OpenAI APIキーを環境に追加します。
export OPENAI_API_KEY="<Your OpenAI API Key>" export ATLAS_CONNECTION_STRING="<Your MongoDB Atlas SRV Connection String>"
注意
接続stringには、次の形式を使用する必要があります。
mongodb+srv://<db_username>:<db_password>@<clusterName>.<hostname>.mongodb.net
Atlas でのカスタム データの保存
このセクションでは、 カーネル を初期化します は、アプリケーションのサービスとプラグインを管理するために使用されるメインのインターフェースです。カーネルを介して、AI サービスを構成し、Atlas をベクトルデータベース(メモリストアとも)としてインスタンス化し、カスタム データを Atlas クラスターにロードします。
次のコードをコピーして、アプリケーションの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; static class Program { static async Task Main(string[] args) { // Get connection string and OpenAI API Key var connectionString = Environment.GetEnvironmentVariable("ATLAS_CONNECTION_STRING"); if (connectionString == null) { Console.WriteLine("You must set your 'ATLAS_CONNECTION_STRING' 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 Atlas 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 { [ ] [ ] public required String Key { get; init; } [ ] [ ] public required string Text { get; init; } [ ] public ReadOnlyMemory<float> Embedding { get; init; } } }
ファイルを保存し、次のコマンドを実行してデータを Atlas にロードします。
dotnet run
Tip
サンプルコードを実行中後、クラスター内の コレクションに移動すると、Atlas UIでベクトル埋め込みとインデックスを表示できます。semantic_kernel_db.test
ベクトル検索クエリの実行
ベクトル埋め込みを作成したら、データに対してベクトル検索クエリを実行できます。
Program.cs
ファイルの Program
クラスの末尾に、文字列 What is my job title?
の基本的なセマンティック検索を実行するための次のコードを追加します。最も関連性の高いドキュメントが出力されます。
1 // Create a text search instance using the InMemory vector store. 2 var textSearch = new VectorStoreTextSearch<DataModel>(recordCollection, embeddingGenerator); 3 4 // Search and return results as TextSearchResult items 5 var query = "What is my job title?"; 6 KernelSearchResults<TextSearchResult> textResults = await textSearch.GetTextSearchResultsAsync(query, new() { Top = 2, Skip = 0 }); 7 await foreach (TextSearchResult result in textResults.Results) 8 { 9 Console.WriteLine($"Answer: {result.Value}"); 10 } 11 Console.WriteLine("Search completed.");
ファイルを保存し、次のコマンドを実行して、セマンティック検索の結果を確認します。
dotnet run
Answer: I am a developer Search completed.
データに関する質問に答えます
このセクションでは、Atlas ベクトル検索とセマンティック カーネルを使用した RAM の実装例を示します。 Atlas ベクトル検索を使用してセマンティックに類似したドキュメントを検索したので、 の クラスの末尾に次のコード例を貼り付け、それらのドキュメントに基づいて質問に回答するようProgram
Program.cs
LM に要求します。
このコードは、次のアクションを実行します。
OpenAI の
gpt-4o
をチャットモデルとして応答を生成するための新しいカーネルを作成します。ベクトルストアを使用して新しいテキスト検索インスタンスを作成します。
チャット モデルに質問するための質問を定義し、変数
retrievedContext
を初期化してベクトルストアのコンテキストを保持します。recordCollection
でWhen did I start using MongoDB?
のセマンティック検索を実行し、最も関連性の高い検索結果を返します。検索されたコンテキストのみに基づいて質問に応答するようAIモデルに指示するプロンプト テンプレートを構築します。
カーネルの
CreateFunctionFromPrompt
関数を使用して、チャット プロンプトからragFunction
という名前の関数を作成します。質問とコンテキストを保持するための新しいオブジェクトを作成して、RG プロンプトの引数を準備します。
カーネルの
InvokeAsync
関数を呼び出して、次のパラメータを使用してチャット モデルから応答を生成します。プロンプト テンプレートを構成する
ragFunction
。質問とコンテキストを含む
ragArguments
。
質問と生成された応答を出力します。
// Create a kernel with OpenAI chat completion IKernelBuilder 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 context var 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 context const string ragPromptTemplate = @" Context: {{$context}} Question: {{$question}} Based *only* on the context provided, answer the question. Answer: "; // 3. Create a function from the RAG prompt template var ragFunction = kernel.CreateFunctionFromPrompt(ragPromptTemplate); // 4. Prepare arguments for the RAG prompt var ragArguments = new KernelArguments { ["question"] = userQuestion, ["context"] = retrievedContext }; // 5. Invoke the RAG prompt var 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 run
Question: When did I start using MongoDB? Retrieved Context: I started using MongoDB two years ago Answer: Two years ago.
Tip
独自のデータを追加し、コードの次の部分を置き換えると、別の質問に対する応答を生成できます。
var userQuestion = "When did I start using MongoDB?"
次のステップ
MongoDBは、次の開発者リソースも提供しています。