Package org.springframework.ai.postgresml

Class PostgresMlEmbeddingModel

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingModel

org.springframework.ai.postgresml.PostgresMlEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, Model<EmbeddingRequest,EmbeddingResponse>, org.springframework.beans.factory.InitializingBean

public class PostgresMlEmbeddingModel
extends AbstractEmbeddingModel
implements org.springframework.beans.factory.InitializingBean

PostgresML EmbeddingModel

Author:

Toshiaki Maki, Christian Tzolov, Soby Chacko

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PostgresMlEmbeddingModel.VectorType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TRANSFORMER_MODEL

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

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
PostgresMlEmbeddingModel(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)	a constructor
PostgresMlEmbeddingModel(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, PostgresMlEmbeddingOptions options)
PostgresMlEmbeddingModel(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, PostgresMlEmbeddingOptions options, boolean createExtension)	a PostgresMlEmbeddingModel constructor

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
EmbeddingResponse	call(EmbeddingRequest request)	Executes a method call to the AI model.
float[]	embed(String text)	Embeds the given text into a vector.
float[]	embed(Document document)	Embeds the given document's content into a vector.
String	getEmbeddingContent(Document document)	Extracts the text content from a Document to be used for embedding.

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

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.EmbeddingModel

embed, embed, embedForResponse

Field Details

DEFAULT_TRANSFORMER_MODEL

public static final String DEFAULT_TRANSFORMER_MODEL

See Also:

• Constant Field Values

Constructor Details

PostgresMlEmbeddingModel

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

a constructor

Parameters:

jdbcTemplate - JdbcTemplate

PostgresMlEmbeddingModel

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

PostgresMlEmbeddingModel

public PostgresMlEmbeddingModel(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
 PostgresMlEmbeddingOptions options,
 boolean createExtension)

a PostgresMlEmbeddingModel constructor

Parameters:

jdbcTemplate - JdbcTemplate to use to interact with the database.

options - PostgresMlEmbeddingOptions to configure the client.

Method Details

embed

public float[] embed(String text)

Description copied from interface: EmbeddingModel

Embeds the given text into a vector.

Specified by:

embed in interface EmbeddingModel

Parameters:

text - the text to embed.

Returns:

the embedded vector.

getEmbeddingContent

public String getEmbeddingContent(Document document)

Description copied from interface: EmbeddingModel

Extracts the text content from a Document to be used for embedding. By default, returns Document.getText(). Implementations that support MetadataMode should override this method to return Document.getFormattedContent(org.springframework.ai.document.MetadataMode) with the appropriate metadata mode, so that metadata is included in the text sent to the embedding API.

Specified by:

getEmbeddingContent in interface EmbeddingModel

Parameters:

document - the document to extract embedding content from.

Returns:

the text content to embed.

embed

public float[] embed(Document document)

Description copied from interface: EmbeddingModel

Embeds the given document's content into a vector.

Specified by:

embed in interface EmbeddingModel

Parameters:

document - the document to embed.

Returns:

the embedded vector.

call

public EmbeddingResponse call(EmbeddingRequest request)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface EmbeddingModel

Specified by:

call in interface Model<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