All Implemented Interfaces:
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`EmbeddingCreateParams.Input.Visitor`	An interface that defines how to map each variant of Input to a value of type T.

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 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 Boolean`	`isString()`
`final Boolean`	`isArrayOfStrings()`
`final Boolean`	`isArrayOfTokens()`
`final Boolean`	`isArrayOfTokenArrays()`
`final String`	`asString()`	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> T`	`accept(EmbeddingCreateParams.Input.Visitor<T> visitor)`
`final EmbeddingCreateParams.Input`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EmbeddingCreateParams.Input`	`ofString(String string)`	The string that will be turned into an embedding.
`final static EmbeddingCreateParams.Input`	`ofArrayOfStrings(List<String> arrayOfStrings)`	The array of strings that will be turned into an embedding.
`final static EmbeddingCreateParams.Input`	`ofArrayOfTokens(List<Long> arrayOfTokens)`	The array of integers that will be turned into an embedding.
`final static EmbeddingCreateParams.Input`	`ofArrayOfTokenArrays(List<List<Long>> arrayOfTokenArrays)`	The array of arrays containing integers that will be turned into an embedding.

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

Constructor Detail

Method Detail

string
```
 final Optional<String> string()
```
The string that will be turned into an embedding.

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.

isString
```
 final Boolean isString()
```

isArrayOfStrings
```
 final Boolean isArrayOfStrings()
```

isArrayOfTokens
```
 final Boolean isArrayOfTokens()
```

isArrayOfTokenArrays
```
 final Boolean isArrayOfTokenArrays()
```

asString
```
 final String asString()
```
The string that will be turned into an embedding.

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.

_json
```
 final Optional<JsonValue> _json()
```

accept

 final <T extends Any> T accept(EmbeddingCreateParams.Input.Visitor<T> visitor)

validate

 final EmbeddingCreateParams.Input validate()

isValid
```
 final Boolean isValid()
```

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

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.

Class EmbeddingCreateParams.Input

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

string

arrayOfStrings

arrayOfTokens

arrayOfTokenArrays

isString

isArrayOfStrings

isArrayOfTokens

isArrayOfTokenArrays

asString

asArrayOfStrings

asArrayOfTokens

asArrayOfTokenArrays

_json

accept

validate

isValid

equals

hashCode

toString

ofString

ofArrayOfStrings

ofArrayOfTokens

ofArrayOfTokenArrays