Class KnowledgeRetrievalOutputMode

java.lang.Object

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

com.azure.search.documents.knowledgebases.models.KnowledgeRetrievalOutputMode

All Implemented Interfaces:

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

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

The output configuration for this retrieval.

Field Summary

Fields

Modifier and Type	Field	Description
static final KnowledgeRetrievalOutputMode	ANSWER_SYNTHESIS	Synthesize an answer for the response payload.
static final KnowledgeRetrievalOutputMode	EXTRACTIVE_DATA	Return data from the knowledge sources directly without generative alteration.

Constructor Summary

Constructors

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

Method Summary

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

EXTRACTIVE_DATA

public static final KnowledgeRetrievalOutputMode EXTRACTIVE_DATA

Return data from the knowledge sources directly without generative alteration.

ANSWER_SYNTHESIS

public static final KnowledgeRetrievalOutputMode ANSWER_SYNTHESIS

Synthesize an answer for the response payload.

Constructor Details

KnowledgeRetrievalOutputMode

@Deprecated
public KnowledgeRetrievalOutputMode()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of KnowledgeRetrievalOutputMode value.

Method Details

fromString

public static KnowledgeRetrievalOutputMode fromString(String name)

Creates or finds a KnowledgeRetrievalOutputMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding KnowledgeRetrievalOutputMode.

values

public static Collection<KnowledgeRetrievalOutputMode> values()

Gets known KnowledgeRetrievalOutputMode values.

Returns:

known KnowledgeRetrievalOutputMode values.