Record Class MistralAiApi.EmbeddingRequest<T>
java.lang.Object
java.lang.Record
org.springframework.ai.mistralai.api.MistralAiApi.EmbeddingRequest<T>
- Record Components:
input
- Input text to embed, encoded as a string or array of tokensmodel
- ID of the model to use.encodingFormat
- The format to return the embeddings in. Can be either float or base64.
- Enclosing class:
MistralAiApi
public static record MistralAiApi.EmbeddingRequest<T>(T input, String model, String encodingFormat)
extends Record
Creates an embedding vector representing the input text.
-
Constructor Summary
ConstructorsConstructorDescriptionEmbeddingRequest
(T input) Create an embedding request with the given input.EmbeddingRequest
(T input, String model) Create an embedding request with the given input, model and encoding format set to float.EmbeddingRequest
(T input, String model, String encodingFormat) Creates an instance of aEmbeddingRequest
record class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of theencodingFormat
record component.final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.input()
Returns the value of theinput
record component.model()
Returns the value of themodel
record component.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
EmbeddingRequest
Create an embedding request with the given input, model and encoding format set to float.- Parameters:
input
- Input text to embed.model
- ID of the model to use.
-
EmbeddingRequest
Create an embedding request with the given input. Encoding format is set to float and user is null and the model is set to 'mistral-embed'.- Parameters:
input
- Input text to embed.
-
EmbeddingRequest
Creates an instance of aEmbeddingRequest
record class.- Parameters:
input
- the value for theinput
record componentmodel
- the value for themodel
record componentencodingFormat
- the value for theencodingFormat
record component
-
-
Method Details
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
input
Returns the value of theinput
record component.- Returns:
- the value of the
input
record component
-
model
Returns the value of themodel
record component.- Returns:
- the value of the
model
record component
-
encodingFormat
Returns the value of theencodingFormat
record component.- Returns:
- the value of the
encodingFormat
record component
-