All Implemented Interfaces:: com.openai.core.Params


public final class EmbeddingCreateParams
 implements Params

Creates an embedding vector representing the input text.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EmbeddingCreateParams.Builder`	A builder for EmbeddingCreateParams.
`public final class`	`EmbeddingCreateParams.Body`
`public final class`	`EmbeddingCreateParams.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.
`public final class`	`EmbeddingCreateParams.EncodingFormat`	The format to return the embeddings in. Can be either `float` or `base64`.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final EmbeddingCreateParams.Input`	`input()`	Input text to embed, encoded as a string or array of tokens.
`final EmbeddingModel`	`model()`	ID of the model to use.
`final Optional<Long>`	`dimensions()`	The number of dimensions the resulting output embeddings should have.
`final Optional<EmbeddingCreateParams.EncodingFormat>`	`encodingFormat()`	The format to return the embeddings in.
`final Optional<String>`	`user()`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
`final JsonField<EmbeddingCreateParams.Input>`	`_input()`	Returns the raw JSON value of input.
`final JsonField<EmbeddingModel>`	`_model()`	Returns the raw JSON value of model.
`final JsonField<Long>`	`_dimensions()`	Returns the raw JSON value of dimensions.
`final JsonField<EmbeddingCreateParams.EncodingFormat>`	`_encodingFormat()`	Returns the raw JSON value of encodingFormat.
`final JsonField<String>`	`_user()`	Returns the raw JSON value of user.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final EmbeddingCreateParams.Builder`	`toBuilder()`
`final EmbeddingCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EmbeddingCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of EmbeddingCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 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.
  - 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()
```
    Returns the raw JSON value of input.
    Unlike input, this method doesn't throw if the JSON field has an unexpected type.
  - _model
```
 final JsonField<EmbeddingModel> _model()
```
    Returns the raw JSON value of model.
    Unlike model, this method doesn't throw if the JSON field has an unexpected type.
  - _dimensions
```
 final JsonField<Long> _dimensions()
```
    Returns the raw JSON value of dimensions.
    Unlike dimensions, this method doesn't throw if the JSON field has an unexpected type.
  - _encodingFormat
```
 final JsonField<EmbeddingCreateParams.EncodingFormat> _encodingFormat()
```
    Returns the raw JSON value of encodingFormat.
    Unlike encodingFormat, this method doesn't throw if the JSON field has an unexpected type.
  - _user
```
 final JsonField<String> _user()
```
    Returns the raw JSON value of user.
    Unlike user, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final EmbeddingCreateParams.Builder toBuilder()
```
  - _body
```
 final EmbeddingCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static EmbeddingCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of EmbeddingCreateParams.
    The following fields are required:
    .input() .model()

Class EmbeddingCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

input

model

dimensions

encodingFormat

user

_input

_model

_dimensions

_encodingFormat

_user

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder