Package org.springframework.ai.azure.openai

Class AzureOpenAiEmbeddingClient

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingClient

org.springframework.ai.azure.openai.AzureOpenAiEmbeddingClient

All Implemented Interfaces:

EmbeddingClient, ModelClient<EmbeddingRequest,EmbeddingResponse>

public class AzureOpenAiEmbeddingClient
extends AbstractEmbeddingClient

Field Summary

Fields inherited from class org.springframework.ai.embedding.AbstractEmbeddingClient

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiEmbeddingClient(com.azure.ai.openai.OpenAIClient azureOpenAiClient)
AzureOpenAiEmbeddingClient(com.azure.ai.openai.OpenAIClient azureOpenAiClient, MetadataMode metadataMode)
AzureOpenAiEmbeddingClient(com.azure.ai.openai.OpenAIClient azureOpenAiClient, MetadataMode metadataMode, AzureOpenAiEmbeddingOptions options)

Method Summary

Modifier and Type	Method	Description
EmbeddingResponse	call(EmbeddingRequest embeddingRequest)	Executes a method call to the AI model.
List<Double>	embed(Document document)	Embeds the given document's content into a vector.
AzureOpenAiEmbeddingOptions	getDefaultOptions()

Methods inherited from class org.springframework.ai.embedding.AbstractEmbeddingClient

dimensions, dimensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.embedding.EmbeddingClient

embed, embed, embedForResponse

Constructor Details

AzureOpenAiEmbeddingClient

public AzureOpenAiEmbeddingClient(com.azure.ai.openai.OpenAIClient azureOpenAiClient)

AzureOpenAiEmbeddingClient

public AzureOpenAiEmbeddingClient(com.azure.ai.openai.OpenAIClient azureOpenAiClient,
 MetadataMode metadataMode)

AzureOpenAiEmbeddingClient

public AzureOpenAiEmbeddingClient(com.azure.ai.openai.OpenAIClient azureOpenAiClient,
 MetadataMode metadataMode,
 AzureOpenAiEmbeddingOptions options)

Method Details

embed

public List<Double> embed(Document document)

Description copied from interface: EmbeddingClient

Embeds the given document's content into a vector.

Parameters:

document - the document to embed.

Returns:

the embedded vector.

call

public EmbeddingResponse call(EmbeddingRequest embeddingRequest)

Description copied from interface: ModelClient

Executes a method call to the AI model.

Parameters:

embeddingRequest - the request object to be sent to the AI model

Returns:

the response from the AI model

getDefaultOptions

public AzureOpenAiEmbeddingOptions getDefaultOptions()