Package com.azure.ai.inference.models

Class EmbeddingEncodingFormat

java.lang.Object

com.azure.core.util.ExpandableStringEnum<EmbeddingEncodingFormat>

com.azure.ai.inference.models.EmbeddingEncodingFormat

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class EmbeddingEncodingFormat
extends com.azure.core.util.ExpandableStringEnum<EmbeddingEncodingFormat>

The format of the embeddings result. Returns a 422 error if the model doesn't support the value or parameter.

Field Summary

Fields

Modifier and Type	Field	Description
static final EmbeddingEncodingFormat	BASE64	Base64.
static final EmbeddingEncodingFormat	BINARY	Binary.
static final EmbeddingEncodingFormat	FLOAT	Floating point.
static final EmbeddingEncodingFormat	INT8	Signed 8-bit integer.
static final EmbeddingEncodingFormat	UBINARY	ubinary.
static final EmbeddingEncodingFormat	UINT8	Unsigned 8-bit integer.

Constructor Summary

Constructors

Constructor	Description
EmbeddingEncodingFormat()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static EmbeddingEncodingFormat	fromString(String name)	Creates or finds a EmbeddingEncodingFormat from its string representation.
static Collection<EmbeddingEncodingFormat>	values()	Gets known EmbeddingEncodingFormat values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

BASE64

public static final EmbeddingEncodingFormat BASE64

Base64.

BINARY

public static final EmbeddingEncodingFormat BINARY

Binary.

FLOAT

public static final EmbeddingEncodingFormat FLOAT

Floating point.

INT8

public static final EmbeddingEncodingFormat INT8

Signed 8-bit integer.

UBINARY

public static final EmbeddingEncodingFormat UBINARY

ubinary.

UINT8

public static final EmbeddingEncodingFormat UINT8

Unsigned 8-bit integer.

Constructor Details

EmbeddingEncodingFormat

@Deprecated
public EmbeddingEncodingFormat()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of EmbeddingEncodingFormat value.

Method Details

fromString

public static EmbeddingEncodingFormat fromString(String name)

Creates or finds a EmbeddingEncodingFormat from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding EmbeddingEncodingFormat.

values

public static Collection<EmbeddingEncodingFormat> values()

Gets known EmbeddingEncodingFormat values.

Returns:

known EmbeddingEncodingFormat values.