Constructor Detail

Method Detail

• input

   final EmbeddingCreateParams.Builder input(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.

• input

   final EmbeddingCreateParams.Builder input(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.

• input

   final EmbeddingCreateParams.Builder input(String string)

  The string that will be turned into an embedding.

• inputOfArrayOfStrings

   final EmbeddingCreateParams.Builder inputOfArrayOfStrings(List<String> arrayOfStrings)

  The array of strings that will be turned into an embedding.

• inputOfArrayOfTokens

   final EmbeddingCreateParams.Builder inputOfArrayOfTokens(List<Long> arrayOfTokens)

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

• inputOfArrayOfTokenArrays

   final EmbeddingCreateParams.Builder inputOfArrayOfTokenArrays(List<List<Long>> arrayOfTokenArrays)

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

• model

   final EmbeddingCreateParams.Builder model(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.

• model

   final EmbeddingCreateParams.Builder model(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.

• model

   final EmbeddingCreateParams.Builder model(String value)

  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 EmbeddingCreateParams.Builder dimensions(Long dimensions)

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

• dimensions

   final EmbeddingCreateParams.Builder dimensions(JsonField<Long> dimensions)

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

• encodingFormat

   final EmbeddingCreateParams.Builder encodingFormat(EmbeddingCreateParams.EncodingFormat encodingFormat)

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

• encodingFormat

   final EmbeddingCreateParams.Builder encodingFormat(JsonField<EmbeddingCreateParams.EncodingFormat> encodingFormat)

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

• user

   final EmbeddingCreateParams.Builder user(String user)

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

• user

   final EmbeddingCreateParams.Builder user(JsonField<String> user)

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

• additionalBodyProperties

   final EmbeddingCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final EmbeddingCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final EmbeddingCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final EmbeddingCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final EmbeddingCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final EmbeddingCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final EmbeddingCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final EmbeddingCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final EmbeddingCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final EmbeddingCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final EmbeddingCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final EmbeddingCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final EmbeddingCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final EmbeddingCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final EmbeddingCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final EmbeddingCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final EmbeddingCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final EmbeddingCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final EmbeddingCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final EmbeddingCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final EmbeddingCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final EmbeddingCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final EmbeddingCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final EmbeddingCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final EmbeddingCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final EmbeddingCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final EmbeddingCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final EmbeddingCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final EmbeddingCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final EmbeddingCreateParams build()