Package nl.dannyj.mistral.models.embedding

Class EmbeddingRequest

java.lang.Object

nl.dannyj.mistral.models.embedding.EmbeddingRequest

All Implemented Interfaces:

Request

public class EmbeddingRequest
extends Object
implements Request

The EmbeddingRequest class represents a request to create embedding for a list of strings. Most of the field descriptions are taken from the Mistral API documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingRequest.EmbeddingRequestBuilder

Constructor Summary

Constructors

Constructor	Description
EmbeddingRequest()
EmbeddingRequest(String model, List<String> input, String encodingFormat)

Method Summary

Modifier and Type	Method	Description
static EmbeddingRequest.EmbeddingRequestBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getEncodingFormat()	The format of the output data.
List<String>	getInput()	The list of strings to embed.
String	getModel()	The ID of the model to use for this request.
int	hashCode()
void	setEncodingFormat(String encodingFormat)	The format of the output data.
void	setInput(List<String> input)	The list of strings to embed.
void	setModel(String model)	The ID of the model to use for this request.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EmbeddingRequest

public EmbeddingRequest(String model,
 List<String> input,
 String encodingFormat)

EmbeddingRequest

public EmbeddingRequest()

Method Details

builder

public static EmbeddingRequest.EmbeddingRequestBuilder builder()

getModel

public String getModel()

The ID of the model to use for this request.

Returns:

The model ID.

getInput

public List<String> getInput()

The list of strings to embed.

Returns:

The list of strings to embed.

getEncodingFormat

public String getEncodingFormat()

The format of the output data.

Returns:

The format of the output data.

setModel

public void setModel(String model)

The ID of the model to use for this request.

Parameters:

model - The model ID.

setInput

public void setInput(List<String> input)

The list of strings to embed.

Parameters:

input - The list of strings to embed. Each entry will be embedded separately.

setEncodingFormat

public void setEncodingFormat(String encodingFormat)

The format of the output data.

Parameters:

encodingFormat - The format of the output data. Can only be "float" is valid for now.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object