Constructor Detail

Method Detail

• body

   final V1CreateEmbeddingParams.Builder body(V1CreateEmbeddingParams.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 V1CreateEmbeddingParams.Builder input(V1CreateEmbeddingParams.Input input)

  Text or array of texts to create embeddings for

• input

   final V1CreateEmbeddingParams.Builder input(JsonField<V1CreateEmbeddingParams.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 V1CreateEmbeddingParams.Builder input(String string)

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

• inputOfStrings

   final V1CreateEmbeddingParams.Builder inputOfStrings(List<String> strings)

  Alias for calling input with Input.ofStrings(strings).

• model

   final V1CreateEmbeddingParams.Builder model(String model)

  Embedding model to use (e.g., text-embedding-ada-002, text-embedding-3-small)

• model

   final V1CreateEmbeddingParams.Builder model(JsonField<String> model)

  Sets Builder.model to an arbitrary JSON value.

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

• dimensions

   final V1CreateEmbeddingParams.Builder dimensions(Long dimensions)

  Number of dimensions for the embeddings (model-specific)

• dimensions

   final V1CreateEmbeddingParams.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 V1CreateEmbeddingParams.Builder encodingFormat(V1CreateEmbeddingParams.EncodingFormat encodingFormat)

  Format for returned embeddings

• encodingFormat

   final V1CreateEmbeddingParams.Builder encodingFormat(JsonField<V1CreateEmbeddingParams.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 V1CreateEmbeddingParams.Builder user(String user)

  Unique identifier for the end-user

• user

   final V1CreateEmbeddingParams.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 V1CreateEmbeddingParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final V1CreateEmbeddingParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final V1CreateEmbeddingParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final V1CreateEmbeddingParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final V1CreateEmbeddingParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final V1CreateEmbeddingParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final V1CreateEmbeddingParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final V1CreateEmbeddingParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final V1CreateEmbeddingParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final V1CreateEmbeddingParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final V1CreateEmbeddingParams build()

  Returns an immutable instance of V1CreateEmbeddingParams.

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

  The following fields are required:

  .input()
  .model()