Package com.azure.ai.inference.models

Class EmbeddingInputType

java.lang.Object

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

com.azure.ai.inference.models.EmbeddingInputType

All Implemented Interfaces:

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

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

Represents the input types used for embedding search.

Field Summary

Fields

Modifier and Type	Field	Description
static final EmbeddingInputType	DOCUMENT	Indicates the input represents a document that is stored in a vector database.
static final EmbeddingInputType	QUERY	Indicates the input represents a search query to find the most relevant documents in your vector database.
static final EmbeddingInputType	TEXT	Indicates the input is a general text input.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static EmbeddingInputType	fromString(String name)	Creates or finds a EmbeddingInputType from its string representation.
static Collection<EmbeddingInputType>	values()	Gets known EmbeddingInputType 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

TEXT

public static final EmbeddingInputType TEXT

Indicates the input is a general text input.

QUERY

public static final EmbeddingInputType QUERY

Indicates the input represents a search query to find the most relevant documents in your vector database.

DOCUMENT

public static final EmbeddingInputType DOCUMENT

Indicates the input represents a document that is stored in a vector database.

Constructor Details

EmbeddingInputType

@Deprecated
public EmbeddingInputType()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of EmbeddingInputType value.

Method Details

fromString

public static EmbeddingInputType fromString(String name)

Creates or finds a EmbeddingInputType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding EmbeddingInputType.

values

public static Collection<EmbeddingInputType> values()

Gets known EmbeddingInputType values.

Returns:

known EmbeddingInputType values.