Package org.springframework.ai.mistralai

Class MistralAiEmbeddingModel

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingModel

org.springframework.ai.mistralai.MistralAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, Model<EmbeddingRequest,EmbeddingResponse>

public class MistralAiEmbeddingModel
extends AbstractEmbeddingModel

Provides the Mistral AI Embedding Model.

Since:

1.0.0

Author:

Ricken Bazolo, Thomas Vitale

See Also:

• AbstractEmbeddingModel

Field Summary

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

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
MistralAiEmbeddingModel(MistralAiApi mistralAiApi)
MistralAiEmbeddingModel(MistralAiApi mistralAiApi, MetadataMode metadataMode)
MistralAiEmbeddingModel(MistralAiApi mistralAiApi, MetadataMode metadataMode, MistralAiEmbeddingOptions options, org.springframework.retry.support.RetryTemplate retryTemplate)
MistralAiEmbeddingModel(MistralAiApi mistralAiApi, MetadataMode metadataMode, MistralAiEmbeddingOptions options, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)
MistralAiEmbeddingModel(MistralAiApi mistralAiApi, MistralAiEmbeddingOptions options)

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.
void	setObservationConvention(EmbeddingModelObservationConvention observationConvention)	Use the provided convention for reporting observation data

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

MistralAiEmbeddingModel

public MistralAiEmbeddingModel(MistralAiApi mistralAiApi)

MistralAiEmbeddingModel

public MistralAiEmbeddingModel(MistralAiApi mistralAiApi,
 MetadataMode metadataMode)

MistralAiEmbeddingModel

public MistralAiEmbeddingModel(MistralAiApi mistralAiApi,
 MistralAiEmbeddingOptions options)

MistralAiEmbeddingModel

public MistralAiEmbeddingModel(MistralAiApi mistralAiApi,
 MetadataMode metadataMode,
 MistralAiEmbeddingOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate)

MistralAiEmbeddingModel

public MistralAiEmbeddingModel(MistralAiApi mistralAiApi,
 MetadataMode metadataMode,
 MistralAiEmbeddingOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

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

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.

setObservationConvention

public void setObservationConvention(EmbeddingModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention