Package io.github.stefanbratanov.jvm.openai

Class EmbeddingsRequest.Builder

java.lang.Object

io.github.stefanbratanov.jvm.openai.EmbeddingsRequest.Builder

Enclosing class:

EmbeddingsRequest

public static class EmbeddingsRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EmbeddingsRequest	build()
EmbeddingsRequest.Builder	dimensions(int dimensions)
EmbeddingsRequest.Builder	encodingFormat(String encodingFormat)
EmbeddingsRequest.Builder	input(int[] input)
EmbeddingsRequest.Builder	input(String... input)
EmbeddingsRequest.Builder	input(List<int[]> input)
EmbeddingsRequest.Builder	model(OpenAIModel model)
EmbeddingsRequest.Builder	model(String model)
EmbeddingsRequest.Builder	user(String user)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

input

public EmbeddingsRequest.Builder input(String... input)

Parameters:

input - The string(s) that will be turned into an embedding.

input

public EmbeddingsRequest.Builder input(int[] input)

Parameters:

input - The array of integers that will be turned into an embedding.

input

public EmbeddingsRequest.Builder input(List<int[]> input)

Parameters:

input - The array of arrays containing integers that will be turned into an embedding.

model

public EmbeddingsRequest.Builder model(String model)

Parameters:

model - ID of the model to use

model

public EmbeddingsRequest.Builder model(OpenAIModel model)

Parameters:

model - OpenAIModel to use

encodingFormat

public EmbeddingsRequest.Builder encodingFormat(String encodingFormat)

Parameters:

encodingFormat - The format to return the embeddings in. Can be either float or base64.

dimensions

public EmbeddingsRequest.Builder dimensions(int dimensions)

Parameters:

dimensions - The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

user

public EmbeddingsRequest.Builder user(String user)

Parameters:

user - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

build

public EmbeddingsRequest build()