Class KnowledgeRetrievalReasoningEffortKind

java.lang.Object

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

com.azure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffortKind

All Implemented Interfaces:

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

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

The amount of effort to use during retrieval.

Field Summary

Fields

Modifier and Type	Field	Description
static final KnowledgeRetrievalReasoningEffortKind	LOW	Use low reasoning during retrieval.
static final KnowledgeRetrievalReasoningEffortKind	MEDIUM	Use a moderate amount of reasoning during retrieval.
static final KnowledgeRetrievalReasoningEffortKind	MINIMAL	Does not perform any source selections, query planning, or iterative search.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class Object

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

Field Details

MINIMAL

public static final KnowledgeRetrievalReasoningEffortKind MINIMAL

Does not perform any source selections, query planning, or iterative search.

LOW

public static final KnowledgeRetrievalReasoningEffortKind LOW

Use low reasoning during retrieval.

MEDIUM

public static final KnowledgeRetrievalReasoningEffortKind MEDIUM

Use a moderate amount of reasoning during retrieval.

Constructor Details

KnowledgeRetrievalReasoningEffortKind

@Deprecated
public KnowledgeRetrievalReasoningEffortKind()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of KnowledgeRetrievalReasoningEffortKind value.

Method Details

fromString

public static KnowledgeRetrievalReasoningEffortKind fromString(String name)

Creates or finds a KnowledgeRetrievalReasoningEffortKind from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding KnowledgeRetrievalReasoningEffortKind.

values

public static Collection<KnowledgeRetrievalReasoningEffortKind> values()

Gets known KnowledgeRetrievalReasoningEffortKind values.

Returns:

known KnowledgeRetrievalReasoningEffortKind values.