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 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

    • 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()