KnowledgeBaseRetrievalOptions Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.1.0-beta.1
  • java.lang.Object
    • com.azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalOptions

Implements

JsonSerializable<KnowledgeBaseRetrievalOptions>

public final class KnowledgeBaseRetrievalOptions
implements JsonSerializable<KnowledgeBaseRetrievalOptions>

The input contract for the retrieval request.

Constructor Summary

Constructor Description
KnowledgeBaseRetrievalOptions()

Creates an instance of KnowledgeBaseRetrievalOptions class.

Method Summary

Modifier and Type Method and Description
static KnowledgeBaseRetrievalOptions fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseRetrievalOptions from the JsonReader.
List<KnowledgeRetrievalIntent> getIntents()

Get the intents property: A list of intended queries to execute without model query planning.
List<KnowledgeSourceParams> getKnowledgeSourceParams()

Get the knowledgeSourceParams property: A list of runtime parameters for the knowledge sources.
Integer getMaxOutputDocuments()

Get the maxOutputDocuments property: Limits the maximum number of documents in the output.
Integer getMaxOutputSize()

Get the maxOutputSize property: Limits the maximum size of the content in the output.
Integer getMaxOutputSizeInTokens()

Get the maxOutputSizeInTokens property: Limits the maximum size of the content in the output.
Integer getMaxRuntimeInSeconds()

Get the maxRuntimeInSeconds property: The maximum runtime in seconds.
List<KnowledgeBaseMessage> getMessages()

Get the messages property: A list of chat message style input.
KnowledgeRetrievalOutputMode getOutputMode()

Get the outputMode property: The output configuration for this retrieval.
KnowledgeRetrievalReasoningEffort getRetrievalReasoningEffort()

Get the retrievalReasoningEffort property: The retrieval reasoning effort configuration.
Boolean isIncludeActivity()

Get the includeActivity property: Indicates retrieval results should include activity information.
KnowledgeBaseRetrievalOptions setIncludeActivity(Boolean includeActivity)

Set the includeActivity property: Indicates retrieval results should include activity information.
KnowledgeBaseRetrievalOptions setIntents(KnowledgeRetrievalIntent[] intents)

Set the intents property: A list of intended queries to execute without model query planning.
KnowledgeBaseRetrievalOptions setIntents(List<KnowledgeRetrievalIntent> intents)

Set the intents property: A list of intended queries to execute without model query planning.
KnowledgeBaseRetrievalOptions setKnowledgeSourceParams(List<KnowledgeSourceParams> knowledgeSourceParams)

Set the knowledgeSourceParams property: A list of runtime parameters for the knowledge sources.
KnowledgeBaseRetrievalOptions setMaxOutputDocuments(Integer maxOutputDocuments)

Set the maxOutputDocuments property: Limits the maximum number of documents in the output.
KnowledgeBaseRetrievalOptions setMaxOutputSize(Integer maxOutputSize)

Set the maxOutputSize property: Limits the maximum size of the content in the output.
KnowledgeBaseRetrievalOptions setMaxOutputSizeInTokens(Integer maxOutputSizeInTokens)

Set the maxOutputSizeInTokens property: Limits the maximum size of the content in the output.
KnowledgeBaseRetrievalOptions setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)

Set the maxRuntimeInSeconds property: The maximum runtime in seconds.
KnowledgeBaseRetrievalOptions setMessages(List<KnowledgeBaseMessage> messages)

Set the messages property: A list of chat message style input.
KnowledgeBaseRetrievalOptions setOutputMode(KnowledgeRetrievalOutputMode outputMode)

Set the outputMode property: The output configuration for this retrieval.
KnowledgeBaseRetrievalOptions setRetrievalReasoningEffort(KnowledgeRetrievalReasoningEffort retrievalReasoningEffort)

Set the retrievalReasoningEffort property: The retrieval reasoning effort configuration.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeBaseRetrievalOptions

public KnowledgeBaseRetrievalOptions()

Creates an instance of KnowledgeBaseRetrievalOptions class.

Method Details

fromJson

public static KnowledgeBaseRetrievalOptions fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseRetrievalOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KnowledgeBaseRetrievalOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the KnowledgeBaseRetrievalOptions.

getIntents

public List<KnowledgeRetrievalIntent> getIntents()

Get the intents property: A list of intended queries to execute without model query planning.

Returns:

the intents value.

getKnowledgeSourceParams

public List<KnowledgeSourceParams> getKnowledgeSourceParams()

Get the knowledgeSourceParams property: A list of runtime parameters for the knowledge sources.

Returns:

the knowledgeSourceParams value.

getMaxOutputDocuments

public Integer getMaxOutputDocuments()

Get the maxOutputDocuments property: Limits the maximum number of documents in the output.

Returns:

the maxOutputDocuments value.

getMaxOutputSize

public Integer getMaxOutputSize()

Get the maxOutputSize property: Limits the maximum size of the content in the output.

Returns:

the maxOutputSize value.

getMaxOutputSizeInTokens

public Integer getMaxOutputSizeInTokens()

Get the maxOutputSizeInTokens property: Limits the maximum size of the content in the output.

Returns:

the maxOutputSizeInTokens value.

getMaxRuntimeInSeconds

public Integer getMaxRuntimeInSeconds()

Get the maxRuntimeInSeconds property: The maximum runtime in seconds.

Returns:

the maxRuntimeInSeconds value.

getMessages

public List<KnowledgeBaseMessage> getMessages()

Get the messages property: A list of chat message style input.

Returns:

the messages value.

getOutputMode

public KnowledgeRetrievalOutputMode getOutputMode()

Get the outputMode property: The output configuration for this retrieval.

Returns:

the outputMode value.

getRetrievalReasoningEffort

public KnowledgeRetrievalReasoningEffort getRetrievalReasoningEffort()

Get the retrievalReasoningEffort property: The retrieval reasoning effort configuration.

Returns:

the retrievalReasoningEffort value.

isIncludeActivity

public Boolean isIncludeActivity()

Get the includeActivity property: Indicates retrieval results should include activity information.

Returns:

the includeActivity value.

setIncludeActivity

public KnowledgeBaseRetrievalOptions setIncludeActivity(Boolean includeActivity)

Set the includeActivity property: Indicates retrieval results should include activity information.

Parameters:

includeActivity - the includeActivity value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setIntents

public KnowledgeBaseRetrievalOptions setIntents(KnowledgeRetrievalIntent[] intents)

Set the intents property: A list of intended queries to execute without model query planning.

Parameters:

intents - the intents value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setIntents

public KnowledgeBaseRetrievalOptions setIntents(List<KnowledgeRetrievalIntent> intents)

Set the intents property: A list of intended queries to execute without model query planning.

Parameters:

intents - the intents value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setKnowledgeSourceParams

public KnowledgeBaseRetrievalOptions setKnowledgeSourceParams(List<KnowledgeSourceParams> knowledgeSourceParams)

Set the knowledgeSourceParams property: A list of runtime parameters for the knowledge sources.

Parameters:

knowledgeSourceParams - the knowledgeSourceParams value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setMaxOutputDocuments

public KnowledgeBaseRetrievalOptions setMaxOutputDocuments(Integer maxOutputDocuments)

Set the maxOutputDocuments property: Limits the maximum number of documents in the output.

Parameters:

maxOutputDocuments - the maxOutputDocuments value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setMaxOutputSize

public KnowledgeBaseRetrievalOptions setMaxOutputSize(Integer maxOutputSize)

Set the maxOutputSize property: Limits the maximum size of the content in the output.

Parameters:

maxOutputSize - the maxOutputSize value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setMaxOutputSizeInTokens

public KnowledgeBaseRetrievalOptions setMaxOutputSizeInTokens(Integer maxOutputSizeInTokens)

Set the maxOutputSizeInTokens property: Limits the maximum size of the content in the output.

Parameters:

maxOutputSizeInTokens - the maxOutputSizeInTokens value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setMaxRuntimeInSeconds

public KnowledgeBaseRetrievalOptions setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)

Set the maxRuntimeInSeconds property: The maximum runtime in seconds.

Parameters:

maxRuntimeInSeconds - the maxRuntimeInSeconds value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setMessages

public KnowledgeBaseRetrievalOptions setMessages(List<KnowledgeBaseMessage> messages)

Set the messages property: A list of chat message style input.

Parameters:

messages - the messages value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setOutputMode

public KnowledgeBaseRetrievalOptions setOutputMode(KnowledgeRetrievalOutputMode outputMode)

Set the outputMode property: The output configuration for this retrieval.

Parameters:

outputMode - the outputMode value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

setRetrievalReasoningEffort

public KnowledgeBaseRetrievalOptions setRetrievalReasoningEffort(KnowledgeRetrievalReasoningEffort retrievalReasoningEffort)

Set the retrievalReasoningEffort property: The retrieval reasoning effort configuration.

Parameters:

retrievalReasoningEffort - the retrievalReasoningEffort value to set.

Returns:

the KnowledgeBaseRetrievalOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to