Package org.springframework.ai.zhipuai

Class ZhiPuAiEmbeddingModel

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingModel

org.springframework.ai.zhipuai.ZhiPuAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, Model<EmbeddingRequest,EmbeddingResponse>

public class ZhiPuAiEmbeddingModel
extends AbstractEmbeddingModel

ZhiPuAI Embedding Model implementation.

Since:

1.0.0

Author:

Geng Rong, Soby Chacko, YuJie Wan

Field Summary

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

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi)	Constructor for the ZhiPuAiEmbeddingModel class.
ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi, MetadataMode metadataMode)	Initializes a new instance of the ZhiPuAiEmbeddingModel class.
ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi, MetadataMode metadataMode, ZhiPuAiEmbeddingOptions zhiPuAiEmbeddingOptions)	Initializes a new instance of the ZhiPuAiEmbeddingModel class.
ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi, MetadataMode metadataMode, ZhiPuAiEmbeddingOptions zhiPuAiEmbeddingOptions, org.springframework.retry.support.RetryTemplate retryTemplate)	Initializes a new instance of the ZhiPuAiEmbeddingModel class.
ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi, MetadataMode metadataMode, ZhiPuAiEmbeddingOptions options, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Initializes a new instance of the ZhiPuAiEmbeddingModel class.

Method Summary

Modifier and Type	Method	Description
EmbeddingResponse	call(EmbeddingRequest request)	Executes a method call to the AI model.
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.
void	setObservationConvention(EmbeddingModelObservationConvention observationConvention)

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

Constructor Details

ZhiPuAiEmbeddingModel

public ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi)

Constructor for the ZhiPuAiEmbeddingModel class.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to use for making API requests.

ZhiPuAiEmbeddingModel

public ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi,
 MetadataMode metadataMode)

Initializes a new instance of the ZhiPuAiEmbeddingModel class.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to use for making API requests.

metadataMode - The mode for generating metadata.

ZhiPuAiEmbeddingModel

public ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi,
 MetadataMode metadataMode,
 ZhiPuAiEmbeddingOptions zhiPuAiEmbeddingOptions)

Initializes a new instance of the ZhiPuAiEmbeddingModel class.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to use for making API requests.

metadataMode - The mode for generating metadata.

zhiPuAiEmbeddingOptions - The options for ZhiPuAI embedding.

ZhiPuAiEmbeddingModel

public ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi,
 MetadataMode metadataMode,
 ZhiPuAiEmbeddingOptions zhiPuAiEmbeddingOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Initializes a new instance of the ZhiPuAiEmbeddingModel class.

Parameters:

zhiPuAiApi - The ZhiPuAiApi instance to use for making API requests.

metadataMode - The mode for generating metadata.

zhiPuAiEmbeddingOptions - The options for ZhiPuAI embedding.

retryTemplate - - The RetryTemplate for retrying failed API requests.

ZhiPuAiEmbeddingModel

public ZhiPuAiEmbeddingModel(ZhiPuAiApi zhiPuAiApi,
 MetadataMode metadataMode,
 ZhiPuAiEmbeddingOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Initializes a new instance of the ZhiPuAiEmbeddingModel class.

Parameters:

zhiPuAiApi - - The ZhiPuAiApi instance to use for making API requests.

metadataMode - - The mode for generating metadata.

options - - The options for ZhiPuAI embedding.

retryTemplate - - The RetryTemplate for retrying failed API requests.

observationRegistry - - The ObservationRegistry used for instrumentation.

Method Details

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.

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.

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.

Parameters:

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

Returns:

the response from the AI model

setObservationConvention

public void setObservationConvention(EmbeddingModelObservationConvention observationConvention)