Skip to main content
The Python SDK and docs are currently in beta. Report issues on GitHub.
Embeddings request input

Fields

FieldTypeRequiredDescriptionExample
dimensionsOptional[int]:heavy_minus_sign:The number of dimensions for the output embeddings1536
encoding_formatOptional[operations.EncodingFormat]:heavy_minus_sign:The format of the output embeddingsfloat
inputoperations.InputUnion:heavy_check_mark:Text, token, or multimodal input(s) to embedThe quick brown fox jumps over the lazy dog
input_typeOptional[str]:heavy_minus_sign:The type of input (e.g. search_query, search_document)search_query
modelstr:heavy_check_mark:The model to use for embeddingsopenai/text-embedding-3-small
providerOptionalNullable[components.ProviderPreferences]:heavy_minus_sign:N/A{"allow_fallbacks": true}
userOptional[str]:heavy_minus_sign:A unique identifier for the end-useruser-1234