Class EmbeddingCreateParams.Input
-
- All Implemented Interfaces:
public final class EmbeddingCreateParams.InputInput 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceEmbeddingCreateParams.Input.VisitorAn interface that defines how to map each variant of Input to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<String>string()The string that will be turned into an embedding. final Optional<List<String>>arrayOfStrings()The array of strings that will be turned into an embedding. final Optional<List<Long>>arrayOfTokens()The array of integers that will be turned into an embedding. final Optional<List<List<Long>>>arrayOfTokenArrays()The array of arrays containing integers that will be turned into an embedding. final BooleanisString()final BooleanisArrayOfStrings()final BooleanisArrayOfTokens()final BooleanisArrayOfTokenArrays()final StringasString()The string that will be turned into an embedding. final List<String>asArrayOfStrings()The array of strings that will be turned into an embedding. final List<Long>asArrayOfTokens()The array of integers that will be turned into an embedding. final List<List<Long>>asArrayOfTokenArrays()The array of arrays containing integers that will be turned into an embedding. final Optional<JsonValue>_json()final <T extends Any> Taccept(EmbeddingCreateParams.Input.Visitor<T> visitor)final EmbeddingCreateParams.Inputvalidate()Booleanequals(Object other)IntegerhashCode()StringtoString()final static EmbeddingCreateParams.InputofString(String string)The string that will be turned into an embedding. final static EmbeddingCreateParams.InputofArrayOfStrings(List<String> arrayOfStrings)The array of strings that will be turned into an embedding. final static EmbeddingCreateParams.InputofArrayOfTokens(List<Long> arrayOfTokens)The array of integers that will be turned into an embedding. final static EmbeddingCreateParams.InputofArrayOfTokenArrays(List<List<Long>> arrayOfTokenArrays)The array of arrays containing integers that will be turned into an embedding. -
-
Method Detail
-
arrayOfStrings
final Optional<List<String>> arrayOfStrings()
The array of strings that will be turned into an embedding.
-
arrayOfTokens
final Optional<List<Long>> arrayOfTokens()
The array of integers that will be turned into an embedding.
-
arrayOfTokenArrays
final Optional<List<List<Long>>> arrayOfTokenArrays()
The array of arrays containing integers that will be turned into an embedding.
-
isArrayOfStrings
final Boolean isArrayOfStrings()
-
isArrayOfTokens
final Boolean isArrayOfTokens()
-
isArrayOfTokenArrays
final Boolean isArrayOfTokenArrays()
-
asArrayOfStrings
final List<String> asArrayOfStrings()
The array of strings that will be turned into an embedding.
-
asArrayOfTokens
final List<Long> asArrayOfTokens()
The array of integers that will be turned into an embedding.
-
asArrayOfTokenArrays
final List<List<Long>> asArrayOfTokenArrays()
The array of arrays containing integers that will be turned into an embedding.
-
accept
final <T extends Any> T accept(EmbeddingCreateParams.Input.Visitor<T> visitor)
-
validate
final EmbeddingCreateParams.Input validate()
-
ofString
final static EmbeddingCreateParams.Input ofString(String string)
The string that will be turned into an embedding.
-
ofArrayOfStrings
final static EmbeddingCreateParams.Input ofArrayOfStrings(List<String> arrayOfStrings)
The array of strings that will be turned into an embedding.
-
ofArrayOfTokens
final static EmbeddingCreateParams.Input ofArrayOfTokens(List<Long> arrayOfTokens)
The array of integers that will be turned into an embedding.
-
ofArrayOfTokenArrays
final static EmbeddingCreateParams.Input ofArrayOfTokenArrays(List<List<Long>> arrayOfTokenArrays)
The array of arrays containing integers that will be turned into an embedding.
-
-
-
-