Azure OpenAI 埋め込み
Azure の OpenAI は OpenAI の機能を継承し、さまざまなタスクに対して安全なテキスト生成と埋め込み計算モデルを提供します。
類似性埋め込みは、2 つ以上のテキスト間の意味上の類似性を捉えるのに適しています。
テキスト検索の埋め込みは、長いドキュメントが短いクエリに関連しているかどうかを測定できます。
コード検索埋め込みは、コードスニペットの埋め込みや自然言語検索クエリの埋め込みに役立ちます。
Azure OpenAI 埋め込みは、cosine similarity を利用してドキュメントとクエリ間の類似性を計算します。
前提条件
Azure OpenAI クライアントには、Azure API キーを使用するか、OpenAI API キーを使用するか、Microsoft Entra ID を使用するかの 3 つの接続オプションがあります。
Azure API キーとエンドポイント
Azure ポータル (英語) の Azure OpenAI サービスセクションから Azure、OpenAI、endpoint、api-key を入手します。
Spring AI は 2 つの構成プロパティを定義します。
spring.ai.azure.openai.api-key: これを Azure から取得したAPI Keyの値に設定します。spring.ai.azure.openai.endpoint: Azure でモデルをプロビジョニングするときに取得したエンドポイント URL に設定します。
環境変数をエクスポートすることで、これらの構成プロパティを設定できます。
export SPRING_AI_AZURE_OPENAI_API_KEY=<INSERT AZURE KEY HERE>
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<INSERT ENDPOINT URL HERE>OpenAI キー
OpenAI サービス (Azure ではない) で認証するには、OpenAI API キーを指定します。これにより、エンドポイントが自動的に api.openai.com/v1 (英語) に設定されます。
この方法を使用する場合は、spring.ai.azure.openai.chat.options.deployment-name プロパティを、使用する OpenAI モデル (英語) の名前に設定します。
export SPRING_AI_AZURE_OPENAI_OPENAI_API_KEY=<INSERT OPENAI KEY HERE>自動構成
Spring AI は、Azure OpenAI 埋め込みモデル用の Spring Boot 自動構成を提供します。これを有効にするには、プロジェクトの Maven pom.xml ファイルに次の依存関係を追加します。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai-spring-boot-starter</artifactId>
</dependency> または、Gradle build.gradle ビルドファイルに保存します。
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai-spring-boot-starter'
}| Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。 |
埋め込みプロパティ
プレフィックス spring.ai.azure.openai は、Azure OpenAI への接続を構成するプロパティプレフィックスです。
| プロパティ | 説明 | デフォルト |
|---|---|---|
spring.ai.azure.openai.api-key |
| - |
spring.ai.azure.openai.endpoint |
| - |
spring.ai.azure.openai.openai-api-key | (非 Azure) OpenAI API キー。Azure OpenAI ではなく、OpenAI サービスで認証するために使用されます。これにより、エンドポイントが api.openai.com/v1 (英語) に自動的に設定されます。 | - |
プレフィックス spring.ai.azure.openai.embedding は、Azure OpenAI の EmbeddingModel 実装を構成するプロパティプレフィックスです。
| プロパティ | 説明 | デフォルト |
|---|---|---|
spring.ai.azure.openai.embedding.enabled | Azure OpenAI 埋め込みモデルを有効にします。 | true |
spring.ai.azure.openai.embedding.metadata-mode | ドキュメントコンテンツ抽出モード | EMBED |
spring.ai.azure.openai.embedding.options.deployment-name | これは、Azure AI ポータルに表示される「デプロイ名」の値です。 | text-embedding-ada-002 |
spring.ai.azure.openai.embedding.options.user | 操作の呼び出し元またはエンドユーザーの識別子。これは、追跡またはレート制限の目的で使用される場合があります。 | - |
spring.ai.azure.openai.embedding.options というプレフィックスが付いたすべてのプロパティは、リクエスト固有のランタイムオプションを EmbeddingRequest 呼び出しに追加することで実行時にオーバーライドできます。 |
ランタイムオプション
AzureOpenAiEmbeddingOptions は、埋め込みリクエストの構成情報を提供します。AzureOpenAiEmbeddingOptions は、オプションを作成するためのビルダーを提供します。
開始時に、AzureOpenAiEmbeddingModel コンストラクターを使用して、すべての埋め込みリクエストに使用されるデフォルトのオプションを設定します。実行時に、AzureOpenAiEmbeddingOptions インスタンスを EmbeddingRequest リクエストに渡すことで、デフォルトのオプションをオーバーライドできます。
たとえば、特定のリクエストのデフォルトのモデル名をオーバーライドするには、次のようにします。
EmbeddingResponse embeddingResponse = embeddingModel.call(
new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
AzureOpenAiEmbeddingOptions.builder()
.withModel("Different-Embedding-Model-Deployment-Name")
.build()));サンプルコード
これにより、クラスに注入できる EmbeddingModel 実装が作成されます。以下は、EmbeddingModel 実装を使用する単純な @Controller クラスの例です。
spring.ai.azure.openai.api-key=YOUR_API_KEY
spring.ai.azure.openai.endpoint=YOUR_ENDPOINT
spring.ai.azure.openai.embedding.options.model=text-embedding-ada-002@RestController
public class EmbeddingController {
private final EmbeddingModel embeddingModel;
@Autowired
public EmbeddingController(EmbeddingModel embeddingModel) {
this.embeddingModel = embeddingModel;
}
@GetMapping("/ai/embedding")
public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
return Map.of("embedding", embeddingResponse);
}
}手動構成
Spring Boot 自動構成を使用したくない場合は、アプリケーションで AzureOpenAiEmbeddingModel を手動で構成できます。このために、プロジェクトの Maven pom.xml ファイルに spring-ai-azure-openai 依存関係を追加します。
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-azure-openai</artifactId>
</dependency> または、Gradle build.gradle ビルドファイルに保存します。
dependencies {
implementation 'org.springframework.ai:spring-ai-azure-openai'
}| Spring AI BOM をビルドファイルに追加するには、"依存関係管理" セクションを参照してください。 |
spring-ai-azure-openai 依存関係により、AzureOpenAiEmbeddingModel へのアクセスも提供されます。AzureOpenAiChatModel の詳細については、Azure OpenAI 埋め込みセクションを参照してください。 |
次に、AzureOpenAiEmbeddingModel インスタンスを作成し、それを使用して 2 つの入力テキスト間の類似性を計算します。
var openAIClient = OpenAIClientBuilder()
.credential(new AzureKeyCredential(System.getenv("AZURE_OPENAI_API_KEY")))
.endpoint(System.getenv("AZURE_OPENAI_ENDPOINT"))
.buildClient();
var embeddingModel = new AzureOpenAiEmbeddingModel(openAIClient)
.withDefaultOptions(AzureOpenAiEmbeddingOptions.builder()
.withModel("text-embedding-ada-002")
.withUser("user-6")
.build());
EmbeddingResponse embeddingResponse = embeddingModel
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));text-embedding-ada-002 は、Azure AI ポータルで示されているように、実際には Deployment Name です。 |
