KnowledgeRetrievalReasoningEffortKind Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.9.0-beta.1

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.search.documents.indexes.models.KnowledgeRetrievalReasoningEffortKind

public final class KnowledgeRetrievalReasoningEffortKind
extends ExpandableStringEnum<KnowledgeRetrievalReasoningEffortKind>

The amount of effort to use during retrieval.

Field Summary

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

Constructor	Description
KnowledgeRetrievalReasoningEffortKind()	Deprecated Use the fromString(String name) factory method. Creates a new instance of KnowledgeRetrievalReasoningEffortKind value.

Method Summary

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

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.

MINIMAL

public static final KnowledgeRetrievalReasoningEffortKind MINIMAL

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

Constructor Details

KnowledgeRetrievalReasoningEffortKind

@Deprecated
public KnowledgeRetrievalReasoningEffortKind()

Deprecated

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