Package org.springframework.ai.embedding

Class EmbeddingRequest

java.lang.Object

org.springframework.ai.embedding.EmbeddingRequest

All Implemented Interfaces:

ModelRequest<List<String>>

public class EmbeddingRequest
extends Object
implements ModelRequest<List<String>>

Request to embed a list of input instructions.

Author:

Christian Tzolov

Constructor Summary

Constructors

Constructor	Description
EmbeddingRequest(List<String> inputs, EmbeddingOptions options)

Method Summary

Modifier and Type	Method	Description
List<String>	getInstructions()	Retrieves the instructions or input required by the AI model.
EmbeddingOptions	getOptions()	Retrieves the customizable options for AI model interactions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmbeddingRequest

public EmbeddingRequest(List<String> inputs,
 @Nullable
 EmbeddingOptions options)

Method Details

getInstructions

public List<String> getInstructions()

Description copied from interface: ModelRequest

Retrieves the instructions or input required by the AI model.

Specified by:

getInstructions in interface ModelRequest<List<String>>

Returns:

the instructions or input required by the AI model

getOptions

@Nullable
public EmbeddingOptions getOptions()

Description copied from interface: ModelRequest

Retrieves the customizable options for AI model interactions.

Specified by:

getOptions in interface ModelRequest<List<String>>

Returns:

the customizable options for AI model interactions