Package org.springframework.ai.postgresml

Class PostgresMlEmbeddingClient

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingClient

org.springframework.ai.postgresml.PostgresMlEmbeddingClient

All Implemented Interfaces:

EmbeddingClient, ModelClient<EmbeddingRequest,EmbeddingResponse>, org.springframework.beans.factory.InitializingBean

public class PostgresMlEmbeddingClient
extends AbstractEmbeddingClient
implements org.springframework.beans.factory.InitializingBean

PostgresML EmbeddingClient

Author:

Toshiaki Maki, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PostgresMlEmbeddingClient.VectorType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TRANSFORMER_MODEL

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

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)	a constructor
PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, String transformer)	Deprecated, for removal: This API element is subject to removal in a future version.
PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, String transformer, PostgresMlEmbeddingClient.VectorType vectorType)	Deprecated, for removal: This API element is subject to removal in a future version. Use the constructor with PostgresMlEmbeddingOptions instead.
PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, String transformer, PostgresMlEmbeddingClient.VectorType vectorType, Map<String,Object> kwargs, MetadataMode metadataMode)	Deprecated, for removal: This API element is subject to removal in a future version.
PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, PostgresMlEmbeddingOptions options)	a PostgresMlEmbeddingClient constructor

Method Summary

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

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, embedForResponse

Field Details

DEFAULT_TRANSFORMER_MODEL

public static final String DEFAULT_TRANSFORMER_MODEL

See Also:

• Constant Field Values

Constructor Details

PostgresMlEmbeddingClient

public PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)

a constructor

Parameters:

jdbcTemplate - JdbcTemplate

PostgresMlEmbeddingClient

public PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
 PostgresMlEmbeddingOptions options)

a PostgresMlEmbeddingClient constructor

Parameters:

jdbcTemplate - JdbcTemplate to use to interact with the database.

options - PostgresMlEmbeddingOptions to configure the client.

PostgresMlEmbeddingClient

@Deprecated(since="0.8.0",
            forRemoval=true)
public PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
 String transformer)

Deprecated, for removal: This API element is subject to removal in a future version.

a constructor

Parameters:

jdbcTemplate - JdbcTemplate

transformer - huggingface sentence-transformer name

PostgresMlEmbeddingClient

@Deprecated(since="0.8.0",
            forRemoval=true)
public PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
 String transformer,
 PostgresMlEmbeddingClient.VectorType vectorType)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the constructor with PostgresMlEmbeddingOptions instead.

a constructor

Parameters:

jdbcTemplate - JdbcTemplate

transformer - huggingface sentence-transformer name

vectorType - vector type in PostgreSQL

PostgresMlEmbeddingClient

@Deprecated(since="0.8.0",
            forRemoval=true)
public PostgresMlEmbeddingClient(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
 String transformer,
 PostgresMlEmbeddingClient.VectorType vectorType,
 Map<String,Object> kwargs,
 MetadataMode metadataMode)

Deprecated, for removal: This API element is subject to removal in a future version.

a constructor * @deprecated Use the constructor with PostgresMlEmbeddingOptions instead.

Parameters:

jdbcTemplate - JdbcTemplate

transformer - huggingface sentence-transformer name

vectorType - vector type in PostgreSQL

kwargs - optional arguments

Method Details

embed

public List<Double> embed(String text)

Description copied from interface: EmbeddingClient

Embeds the given text into a vector.

Specified by:

embed in interface EmbeddingClient

Parameters:

text - the text to embed.

Returns:

the embedded vector.

embed

public List<Double> embed(Document document)

Description copied from interface: EmbeddingClient

Embeds the given document's content into a vector.

Specified by:

embed in interface EmbeddingClient

Parameters:

document - the document to embed.

Returns:

the embedded vector.

call

public EmbeddingResponse call(EmbeddingRequest request)

Description copied from interface: ModelClient

Executes a method call to the AI model.

Specified by:

call in interface EmbeddingClient

Specified by:

call in interface ModelClient<EmbeddingRequest,EmbeddingResponse>

Parameters:

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

Returns:

the response from the AI model

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean