EmbeddingInputType Class

Package:
com.azure.ai.inference.models
Maven Artifact:
com.azure:azure-ai-inference:1.0.0-beta.5

public final class EmbeddingInputType
extends ExpandableStringEnum<EmbeddingInputType>

Represents the input types used for embedding search.

Field Summary

Modifier and Type Field and 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

Constructor Description
EmbeddingInputType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of EmbeddingInputType value.

Method Summary

Modifier and Type Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

DOCUMENT

public static final EmbeddingInputType DOCUMENT

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

QUERY

public static final EmbeddingInputType QUERY

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

TEXT

public static final EmbeddingInputType TEXT

Indicates the input is a general text input.

Constructor Details

EmbeddingInputType

@Deprecated
public EmbeddingInputType()

Deprecated

Use the fromString(String name) 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.

Applies to