OpenAIMemoryBuilderExtensions.WithAzureOpenAITextEmbeddingGeneration Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.OpenAI

Assembly:: Microsoft.SemanticKernel.Connectors.OpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.OpenAI v1.15.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

WithAzureOpenAITextEmbeddingGeneration(MemoryBuilder, String, String, TokenCredential, String, HttpClient, Nullable<Int32>)	Adds an Azure OpenAI text embeddings service. See https://learn.microsoft.com/azure/cognitive-services/openai for service details.
WithAzureOpenAITextEmbeddingGeneration(MemoryBuilder, String, String, String, String, HttpClient, Nullable<Int32>)	Adds an Azure OpenAI text embeddings service. See https://learn.microsoft.com/azure/cognitive-services/openai for service details.

WithAzureOpenAITextEmbeddingGeneration(MemoryBuilder, String, String, TokenCredential, String, HttpClient, Nullable<Int32>)

Adds an Azure OpenAI text embeddings service. See https://learn.microsoft.com/azure/cognitive-services/openai for service details.

public static Microsoft.SemanticKernel.Memory.MemoryBuilder WithAzureOpenAITextEmbeddingGeneration (this Microsoft.SemanticKernel.Memory.MemoryBuilder builder, string deploymentName, string endpoint, Azure.Core.TokenCredential credential, string? modelId = default, System.Net.Http.HttpClient? httpClient = default, int? dimensions = default);

static member WithAzureOpenAITextEmbeddingGeneration : Microsoft.SemanticKernel.Memory.MemoryBuilder * string * string * Azure.Core.TokenCredential * string * System.Net.Http.HttpClient * Nullable<int> -> Microsoft.SemanticKernel.Memory.MemoryBuilder

<Extension()>
Public Function WithAzureOpenAITextEmbeddingGeneration (builder As MemoryBuilder, deploymentName As String, endpoint As String, credential As TokenCredential, Optional modelId As String = Nothing, Optional httpClient As HttpClient = Nothing, Optional dimensions As Nullable(Of Integer) = Nothing) As MemoryBuilder

Parameters

builder: MemoryBuilder

The MemoryBuilder instance

deploymentName: String

Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource

endpoint: String

Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

credential: TokenCredential

Token credentials, e.g. DefaultAzureCredential, ManagedIdentityCredential, EnvironmentCredential, etc.

modelId: String

Model identifier

httpClient: HttpClient

Custom HttpClient for HTTP requests.

dimensions: Nullable<Int32>

The number of dimensions the resulting output embeddings should have. Only supported in "text-embedding-3" and later models.

Returns

MemoryBuilder

Self instance

Applies to

WithAzureOpenAITextEmbeddingGeneration(MemoryBuilder, String, String, String, String, HttpClient, Nullable<Int32>)

Adds an Azure OpenAI text embeddings service. See https://learn.microsoft.com/azure/cognitive-services/openai for service details.

public static Microsoft.SemanticKernel.Memory.MemoryBuilder WithAzureOpenAITextEmbeddingGeneration (this Microsoft.SemanticKernel.Memory.MemoryBuilder builder, string deploymentName, string endpoint, string apiKey, string? modelId = default, System.Net.Http.HttpClient? httpClient = default, int? dimensions = default);

static member WithAzureOpenAITextEmbeddingGeneration : Microsoft.SemanticKernel.Memory.MemoryBuilder * string * string * string * string * System.Net.Http.HttpClient * Nullable<int> -> Microsoft.SemanticKernel.Memory.MemoryBuilder

<Extension()>
Public Function WithAzureOpenAITextEmbeddingGeneration (builder As MemoryBuilder, deploymentName As String, endpoint As String, apiKey As String, Optional modelId As String = Nothing, Optional httpClient As HttpClient = Nothing, Optional dimensions As Nullable(Of Integer) = Nothing) As MemoryBuilder