Constructor Detail

Method Detail

• input

   final EmbeddingCreateParams.Input input()

  Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens. Some models may also impose a limit on total number of tokens summed across inputs.

• model

   final EmbeddingModel model()

  ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

• dimensions

   final Optional<Long> dimensions()

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

• encodingFormat

   final Optional<EmbeddingCreateParams.EncodingFormat> encodingFormat()

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

• user

   final Optional<String> user()

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

• _input

   final JsonField<EmbeddingCreateParams.Input> _input()

  Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens. Some models may also impose a limit on total number of tokens summed across inputs.

• _model

   final JsonField<EmbeddingModel> _model()

  ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

• _dimensions

   final JsonField<Long> _dimensions()

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

• _encodingFormat

   final JsonField<EmbeddingCreateParams.EncodingFormat> _encodingFormat()

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

• _user

   final JsonField<String> _user()

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

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• validate

   final EmbeddingCreateParams.EmbeddingCreateBody validate()

• toBuilder

   final EmbeddingCreateParams.EmbeddingCreateBody.Builder toBuilder()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static EmbeddingCreateParams.EmbeddingCreateBody.Builder builder()