Package com.azure.ai.inference.models

Class ExtraParameters

java.lang.Object

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

com.azure.ai.inference.models.ExtraParameters

All Implemented Interfaces:

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

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

Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.

Field Summary

Fields

Modifier and Type	Field	Description
static final ExtraParameters	DROP	The service will ignore (drop) extra parameters in the request payload.
static final ExtraParameters	ERROR	The service will error if it detected extra parameters in the request payload.
static final ExtraParameters	PASS_THROUGH	The service will pass extra parameters to the back-end AI model.

Constructor Summary

Constructors

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

Method Summary

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

ERROR

public static final ExtraParameters ERROR

The service will error if it detected extra parameters in the request payload. This is the service default.

DROP

public static final ExtraParameters DROP

The service will ignore (drop) extra parameters in the request payload. It will only pass the known parameters to the back-end AI model.

PASS_THROUGH

public static final ExtraParameters PASS_THROUGH

The service will pass extra parameters to the back-end AI model.

Constructor Details

ExtraParameters

@Deprecated
public ExtraParameters()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ExtraParameters value.

Method Details

fromString

public static ExtraParameters fromString(String name)

Creates or finds a ExtraParameters from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ExtraParameters.

values

public static Collection<ExtraParameters> values()

Gets known ExtraParameters values.

Returns:

known ExtraParameters values.