Constructor Detail

Method Detail

• body

   final EmbeddingCreateParams.Builder body(EmbeddingCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • input

  • model

  • dimensions

  • encodingFormat

  • user

  • etc.

• 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 all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.

• input

   final EmbeddingCreateParams.Builder input(JsonField<EmbeddingCreateParams.Input> input)

  Sets Builder.input to an arbitrary JSON value.

  You should usually call Builder.input with a well-typed Input value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• input

   final EmbeddingCreateParams.Builder input(String string)

  Alias for calling input with Input.ofString(string).

• inputOfArrayOfStrings

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

  Alias for calling input with Input.ofArrayOfStrings(arrayOfStrings).

• inputOfArrayOfTokens

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

  Alias for calling input with Input.ofArrayOfTokens(arrayOfTokens).

• inputOfArrayOfTokenArrays

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

  Alias for calling input with Input.ofArrayOfTokenArrays(arrayOfTokenArrays).

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

  Sets Builder.model to an arbitrary JSON value.

  You should usually call Builder.model with a well-typed EmbeddingModel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final EmbeddingCreateParams.Builder model(String value)

  Sets model to an arbitrary String.

  You should usually call model with a well-typed EmbeddingModel constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

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

  Sets Builder.dimensions to an arbitrary JSON value.

  You should usually call Builder.dimensions with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

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

  Sets Builder.encodingFormat to an arbitrary JSON value.

  You should usually call Builder.encodingFormat with a well-typed EncodingFormat value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

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

  Sets Builder.user to an arbitrary JSON value.

  You should usually call Builder.user with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

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

  Returns an immutable instance of EmbeddingCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .input()
  .model()