Package com.sap.ai.sdk.orchestration.model

Class ModuleResultsStreaming

java.lang.Object

com.sap.ai.sdk.orchestration.model.ModuleResultsStreaming

public class ModuleResultsStreaming
extends Object

Streaming results of each module.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModuleResultsStreaming()	Default constructor for ModuleResultsStreaming.

Method Summary

Modifier and Type	Method	Description
ModuleResultsStreaming	addOutputUnmaskingItem(LLMChoiceStreaming outputUnmaskingItem)	Add one outputUnmasking instance to this ModuleResultsStreaming.
ModuleResultsStreaming	addTemplatingItem(ChatMessage templatingItem)	Add one templating instance to this ModuleResultsStreaming.
static ModuleResultsStreaming	create()	Create a new ModuleResultsStreaming instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ModuleResultsStreaming.
GenericModuleResult	getGrounding()	Get grounding
GenericModuleResult	getInputFiltering()	Get inputFiltering
GenericModuleResult	getInputMasking()	Get inputMasking
InputTranslationModuleResult	getInputTranslation()	Get inputTranslation
LLMModuleResultStreaming	getLlm()	Get llm
GenericModuleResult	getOutputFiltering()	Get outputFiltering
GenericModuleResult	getOutputTranslation()	Get outputTranslation
List<LLMChoiceStreaming>	getOutputUnmasking()	Get outputUnmasking
List<ChatMessage>	getTemplating()	Get templating
ModuleResultsStreaming	grounding(GenericModuleResult grounding)	Set the grounding of this ModuleResultsStreaming instance and return the same instance.
int	hashCode()
ModuleResultsStreaming	inputFiltering(GenericModuleResult inputFiltering)	Set the inputFiltering of this ModuleResultsStreaming instance and return the same instance.
ModuleResultsStreaming	inputMasking(GenericModuleResult inputMasking)	Set the inputMasking of this ModuleResultsStreaming instance and return the same instance.
ModuleResultsStreaming	inputTranslation(InputTranslationModuleResult inputTranslation)	Set the inputTranslation of this ModuleResultsStreaming instance and return the same instance.
ModuleResultsStreaming	llm(LLMModuleResultStreaming llm)	Set the llm of this ModuleResultsStreaming instance and return the same instance.
ModuleResultsStreaming	outputFiltering(GenericModuleResult outputFiltering)	Set the outputFiltering of this ModuleResultsStreaming instance and return the same instance.
ModuleResultsStreaming	outputTranslation(GenericModuleResult outputTranslation)	Set the outputTranslation of this ModuleResultsStreaming instance and return the same instance.
ModuleResultsStreaming	outputUnmasking(List<LLMChoiceStreaming> outputUnmasking)	Set the outputUnmasking of this ModuleResultsStreaming instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ModuleResultsStreaming instance.
void	setGrounding(GenericModuleResult grounding)	Set the grounding of this ModuleResultsStreaming instance.
void	setInputFiltering(GenericModuleResult inputFiltering)	Set the inputFiltering of this ModuleResultsStreaming instance.
void	setInputMasking(GenericModuleResult inputMasking)	Set the inputMasking of this ModuleResultsStreaming instance.
void	setInputTranslation(InputTranslationModuleResult inputTranslation)	Set the inputTranslation of this ModuleResultsStreaming instance.
void	setLlm(LLMModuleResultStreaming llm)	Set the llm of this ModuleResultsStreaming instance.
void	setOutputFiltering(GenericModuleResult outputFiltering)	Set the outputFiltering of this ModuleResultsStreaming instance.
void	setOutputTranslation(GenericModuleResult outputTranslation)	Set the outputTranslation of this ModuleResultsStreaming instance.
void	setOutputUnmasking(List<LLMChoiceStreaming> outputUnmasking)	Set the outputUnmasking of this ModuleResultsStreaming instance.
void	setTemplating(List<ChatMessage> templating)	Set the templating of this ModuleResultsStreaming instance.
ModuleResultsStreaming	templating(List<ChatMessage> templating)	Set the templating of this ModuleResultsStreaming instance and return the same instance.
Map<String,Object>	toMap()	Get the value of all properties of this ModuleResultsStreaming instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleResultsStreaming

protected ModuleResultsStreaming()

Default constructor for ModuleResultsStreaming.

Method Details

grounding

@Nonnull
public ModuleResultsStreaming grounding(@Nullable
 GenericModuleResult grounding)

Set the grounding of this ModuleResultsStreaming instance and return the same instance.

Parameters:

grounding - The grounding of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getGrounding

@Nonnull
public GenericModuleResult getGrounding()

Get grounding

Returns:

grounding The grounding of this ModuleResultsStreaming instance.

setGrounding

public void setGrounding(@Nullable
 GenericModuleResult grounding)

Set the grounding of this ModuleResultsStreaming instance.

Parameters:

grounding - The grounding of this ModuleResultsStreaming

templating

@Nonnull
public ModuleResultsStreaming templating(@Nullable
 List<ChatMessage> templating)

Set the templating of this ModuleResultsStreaming instance and return the same instance.

Parameters:

templating - The templating of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

addTemplatingItem

@Nonnull
public ModuleResultsStreaming addTemplatingItem(@Nonnull
 ChatMessage templatingItem)

Add one templating instance to this ModuleResultsStreaming.

Parameters:

templatingItem - The templating that should be added

Returns:

The same instance of type ModuleResultsStreaming

getTemplating

@Nonnull
public List<ChatMessage> getTemplating()

Get templating

Returns:

templating The templating of this ModuleResultsStreaming instance.

setTemplating

public void setTemplating(@Nullable
 List<ChatMessage> templating)

Set the templating of this ModuleResultsStreaming instance.

Parameters:

templating - The templating of this ModuleResultsStreaming

inputTranslation

@Nonnull
public ModuleResultsStreaming inputTranslation(@Nullable
 InputTranslationModuleResult inputTranslation)

Set the inputTranslation of this ModuleResultsStreaming instance and return the same instance.

Parameters:

inputTranslation - The inputTranslation of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getInputTranslation

@Nonnull
public InputTranslationModuleResult getInputTranslation()

Get inputTranslation

Returns:

inputTranslation The inputTranslation of this ModuleResultsStreaming instance.

setInputTranslation

public void setInputTranslation(@Nullable
 InputTranslationModuleResult inputTranslation)

Set the inputTranslation of this ModuleResultsStreaming instance.

Parameters:

inputTranslation - The inputTranslation of this ModuleResultsStreaming

inputMasking

@Nonnull
public ModuleResultsStreaming inputMasking(@Nullable
 GenericModuleResult inputMasking)

Set the inputMasking of this ModuleResultsStreaming instance and return the same instance.

Parameters:

inputMasking - The inputMasking of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getInputMasking

@Nonnull
public GenericModuleResult getInputMasking()

Get inputMasking

Returns:

inputMasking The inputMasking of this ModuleResultsStreaming instance.

setInputMasking

public void setInputMasking(@Nullable
 GenericModuleResult inputMasking)

Set the inputMasking of this ModuleResultsStreaming instance.

Parameters:

inputMasking - The inputMasking of this ModuleResultsStreaming

inputFiltering

@Nonnull
public ModuleResultsStreaming inputFiltering(@Nullable
 GenericModuleResult inputFiltering)

Set the inputFiltering of this ModuleResultsStreaming instance and return the same instance.

Parameters:

inputFiltering - The inputFiltering of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getInputFiltering

@Nonnull
public GenericModuleResult getInputFiltering()

Get inputFiltering

Returns:

inputFiltering The inputFiltering of this ModuleResultsStreaming instance.

setInputFiltering

public void setInputFiltering(@Nullable
 GenericModuleResult inputFiltering)

Set the inputFiltering of this ModuleResultsStreaming instance.

Parameters:

inputFiltering - The inputFiltering of this ModuleResultsStreaming

outputFiltering

@Nonnull
public ModuleResultsStreaming outputFiltering(@Nullable
 GenericModuleResult outputFiltering)

Set the outputFiltering of this ModuleResultsStreaming instance and return the same instance.

Parameters:

outputFiltering - The outputFiltering of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getOutputFiltering

@Nonnull
public GenericModuleResult getOutputFiltering()

Get outputFiltering

Returns:

outputFiltering The outputFiltering of this ModuleResultsStreaming instance.

setOutputFiltering

public void setOutputFiltering(@Nullable
 GenericModuleResult outputFiltering)

Set the outputFiltering of this ModuleResultsStreaming instance.

Parameters:

outputFiltering - The outputFiltering of this ModuleResultsStreaming

outputTranslation

@Nonnull
public ModuleResultsStreaming outputTranslation(@Nullable
 GenericModuleResult outputTranslation)

Set the outputTranslation of this ModuleResultsStreaming instance and return the same instance.

Parameters:

outputTranslation - The outputTranslation of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getOutputTranslation

@Nonnull
public GenericModuleResult getOutputTranslation()

Get outputTranslation

Returns:

outputTranslation The outputTranslation of this ModuleResultsStreaming instance.

setOutputTranslation

public void setOutputTranslation(@Nullable
 GenericModuleResult outputTranslation)

Set the outputTranslation of this ModuleResultsStreaming instance.

Parameters:

outputTranslation - The outputTranslation of this ModuleResultsStreaming

llm

@Nonnull
public ModuleResultsStreaming llm(@Nullable
 LLMModuleResultStreaming llm)

Set the llm of this ModuleResultsStreaming instance and return the same instance.

Parameters:

llm - The llm of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

getLlm

@Nonnull
public LLMModuleResultStreaming getLlm()

Get llm

Returns:

llm The llm of this ModuleResultsStreaming instance.

setLlm

public void setLlm(@Nullable
 LLMModuleResultStreaming llm)

Set the llm of this ModuleResultsStreaming instance.

Parameters:

llm - The llm of this ModuleResultsStreaming

outputUnmasking

@Nonnull
public ModuleResultsStreaming outputUnmasking(@Nullable
 List<LLMChoiceStreaming> outputUnmasking)

Set the outputUnmasking of this ModuleResultsStreaming instance and return the same instance.

Parameters:

outputUnmasking - The outputUnmasking of this ModuleResultsStreaming

Returns:

The same instance of this ModuleResultsStreaming class

addOutputUnmaskingItem

@Nonnull
public ModuleResultsStreaming addOutputUnmaskingItem(@Nonnull
 LLMChoiceStreaming outputUnmaskingItem)

Add one outputUnmasking instance to this ModuleResultsStreaming.

Parameters:

outputUnmaskingItem - The outputUnmasking that should be added

Returns:

The same instance of type ModuleResultsStreaming

getOutputUnmasking

@Nonnull
public List<LLMChoiceStreaming> getOutputUnmasking()

Get outputUnmasking

Returns:

outputUnmasking The outputUnmasking of this ModuleResultsStreaming instance.

setOutputUnmasking

public void setOutputUnmasking(@Nullable
 List<LLMChoiceStreaming> outputUnmasking)

Set the outputUnmasking of this ModuleResultsStreaming instance.

Parameters:

outputUnmasking - The outputUnmasking of this ModuleResultsStreaming

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ModuleResultsStreaming.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this ModuleResultsStreaming instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this ModuleResultsStreaming instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this ModuleResultsStreaming instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static ModuleResultsStreaming create()

Create a new ModuleResultsStreaming instance. No arguments are required.