Package com.azure.ai.inference.models

Class ChatMessageImageDetailLevel

java.lang.Object

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

com.azure.ai.inference.models.ChatMessageImageDetailLevel

All Implemented Interfaces:

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

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

A representation of the possible image detail levels for image-based chat completions message content.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatMessageImageDetailLevel	AUTO	Specifies that the model should determine which detail level to apply using heuristics like image size.
static final ChatMessageImageDetailLevel	HIGH	Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed images but may also be slower and consume more tokens.
static final ChatMessageImageDetailLevel	LOW	Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer tokens but may also be less accurate for highly detailed images.

Constructor Summary

Constructors

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

Method Summary

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

AUTO

public static final ChatMessageImageDetailLevel AUTO

Specifies that the model should determine which detail level to apply using heuristics like image size.

LOW

public static final ChatMessageImageDetailLevel LOW

Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer tokens but may also be less accurate for highly detailed images.

HIGH

public static final ChatMessageImageDetailLevel HIGH

Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed images but may also be slower and consume more tokens.

Constructor Details

ChatMessageImageDetailLevel

@Deprecated
public ChatMessageImageDetailLevel()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ChatMessageImageDetailLevel value.

Method Details

fromString

public static ChatMessageImageDetailLevel fromString(String name)

Creates or finds a ChatMessageImageDetailLevel from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ChatMessageImageDetailLevel.

values

public static Collection<ChatMessageImageDetailLevel> values()

Gets known ChatMessageImageDetailLevel values.

Returns:

known ChatMessageImageDetailLevel values.