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

Class ModuleResultsBase

java.lang.Object

com.sap.ai.sdk.orchestration.model.ModuleResultsBase

public class ModuleResultsBase
extends Object

Results of each module of /embeddings endpoint(e.g. input masking).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ModuleResultsBase	addTemplatingItem(ChatMessage templatingItem)	Add one templating instance to this ModuleResultsBase.
static ModuleResultsBase	create()	Create a new ModuleResultsBase 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 ModuleResultsBase.
GenericModuleResult	getGrounding()	Get grounding
GenericModuleResult	getInputFiltering()	Get inputFiltering
GenericModuleResult	getInputMasking()	Get inputMasking
InputTranslationModuleResult	getInputTranslation()	Get inputTranslation
GenericModuleResult	getOutputFiltering()	Get outputFiltering
GenericModuleResult	getOutputTranslation()	Get outputTranslation
List<ChatMessage>	getTemplating()	Get templating
ModuleResultsBase	grounding(GenericModuleResult grounding)	Set the grounding of this ModuleResultsBase instance and return the same instance.
int	hashCode()
ModuleResultsBase	inputFiltering(GenericModuleResult inputFiltering)	Set the inputFiltering of this ModuleResultsBase instance and return the same instance.
ModuleResultsBase	inputMasking(GenericModuleResult inputMasking)	Set the inputMasking of this ModuleResultsBase instance and return the same instance.
ModuleResultsBase	inputTranslation(InputTranslationModuleResult inputTranslation)	Set the inputTranslation of this ModuleResultsBase instance and return the same instance.
ModuleResultsBase	outputFiltering(GenericModuleResult outputFiltering)	Set the outputFiltering of this ModuleResultsBase instance and return the same instance.
ModuleResultsBase	outputTranslation(GenericModuleResult outputTranslation)	Set the outputTranslation of this ModuleResultsBase instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ModuleResultsBase instance.
void	setGrounding(GenericModuleResult grounding)	Set the grounding of this ModuleResultsBase instance.
void	setInputFiltering(GenericModuleResult inputFiltering)	Set the inputFiltering of this ModuleResultsBase instance.
void	setInputMasking(GenericModuleResult inputMasking)	Set the inputMasking of this ModuleResultsBase instance.
void	setInputTranslation(InputTranslationModuleResult inputTranslation)	Set the inputTranslation of this ModuleResultsBase instance.
void	setOutputFiltering(GenericModuleResult outputFiltering)	Set the outputFiltering of this ModuleResultsBase instance.
void	setOutputTranslation(GenericModuleResult outputTranslation)	Set the outputTranslation of this ModuleResultsBase instance.
void	setTemplating(List<ChatMessage> templating)	Set the templating of this ModuleResultsBase instance.
ModuleResultsBase	templating(List<ChatMessage> templating)	Set the templating of this ModuleResultsBase instance and return the same instance.
Map<String,Object>	toMap()	Get the value of all properties of this ModuleResultsBase instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleResultsBase

protected ModuleResultsBase()

Default constructor for ModuleResultsBase.

Method Details

grounding

@Nonnull
public ModuleResultsBase grounding(@Nullable
 GenericModuleResult grounding)

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

Parameters:

grounding - The grounding of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

getGrounding

@Nonnull
public GenericModuleResult getGrounding()

Get grounding

Returns:

grounding The grounding of this ModuleResultsBase instance.

setGrounding

public void setGrounding(@Nullable
 GenericModuleResult grounding)

Set the grounding of this ModuleResultsBase instance.

Parameters:

grounding - The grounding of this ModuleResultsBase

templating

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

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

Parameters:

templating - The templating of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

addTemplatingItem

@Nonnull
public ModuleResultsBase addTemplatingItem(@Nonnull
 ChatMessage templatingItem)

Add one templating instance to this ModuleResultsBase.

Parameters:

templatingItem - The templating that should be added

Returns:

The same instance of type ModuleResultsBase

getTemplating

@Nonnull
public List<ChatMessage> getTemplating()

Get templating

Returns:

templating The templating of this ModuleResultsBase instance.

setTemplating

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

Set the templating of this ModuleResultsBase instance.

Parameters:

templating - The templating of this ModuleResultsBase

inputTranslation

@Nonnull
public ModuleResultsBase inputTranslation(@Nullable
 InputTranslationModuleResult inputTranslation)

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

Parameters:

inputTranslation - The inputTranslation of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

getInputTranslation

@Nonnull
public InputTranslationModuleResult getInputTranslation()

Get inputTranslation

Returns:

inputTranslation The inputTranslation of this ModuleResultsBase instance.

setInputTranslation

public void setInputTranslation(@Nullable
 InputTranslationModuleResult inputTranslation)

Set the inputTranslation of this ModuleResultsBase instance.

Parameters:

inputTranslation - The inputTranslation of this ModuleResultsBase

inputMasking

@Nonnull
public ModuleResultsBase inputMasking(@Nullable
 GenericModuleResult inputMasking)

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

Parameters:

inputMasking - The inputMasking of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

getInputMasking

@Nonnull
public GenericModuleResult getInputMasking()

Get inputMasking

Returns:

inputMasking The inputMasking of this ModuleResultsBase instance.

setInputMasking

public void setInputMasking(@Nullable
 GenericModuleResult inputMasking)

Set the inputMasking of this ModuleResultsBase instance.

Parameters:

inputMasking - The inputMasking of this ModuleResultsBase

inputFiltering

@Nonnull
public ModuleResultsBase inputFiltering(@Nullable
 GenericModuleResult inputFiltering)

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

Parameters:

inputFiltering - The inputFiltering of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

getInputFiltering

@Nonnull
public GenericModuleResult getInputFiltering()

Get inputFiltering

Returns:

inputFiltering The inputFiltering of this ModuleResultsBase instance.

setInputFiltering

public void setInputFiltering(@Nullable
 GenericModuleResult inputFiltering)

Set the inputFiltering of this ModuleResultsBase instance.

Parameters:

inputFiltering - The inputFiltering of this ModuleResultsBase

outputFiltering

@Nonnull
public ModuleResultsBase outputFiltering(@Nullable
 GenericModuleResult outputFiltering)

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

Parameters:

outputFiltering - The outputFiltering of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

getOutputFiltering

@Nonnull
public GenericModuleResult getOutputFiltering()

Get outputFiltering

Returns:

outputFiltering The outputFiltering of this ModuleResultsBase instance.

setOutputFiltering

public void setOutputFiltering(@Nullable
 GenericModuleResult outputFiltering)

Set the outputFiltering of this ModuleResultsBase instance.

Parameters:

outputFiltering - The outputFiltering of this ModuleResultsBase

outputTranslation

@Nonnull
public ModuleResultsBase outputTranslation(@Nullable
 GenericModuleResult outputTranslation)

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

Parameters:

outputTranslation - The outputTranslation of this ModuleResultsBase

Returns:

The same instance of this ModuleResultsBase class

getOutputTranslation

@Nonnull
public GenericModuleResult getOutputTranslation()

Get outputTranslation

Returns:

outputTranslation The outputTranslation of this ModuleResultsBase instance.

setOutputTranslation

public void setOutputTranslation(@Nullable
 GenericModuleResult outputTranslation)

Set the outputTranslation of this ModuleResultsBase instance.

Parameters:

outputTranslation - The outputTranslation of this ModuleResultsBase

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ModuleResultsBase.

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 ModuleResultsBase 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 ModuleResultsBase 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 ModuleResultsBase 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 ModuleResultsBase create()

Create a new ModuleResultsBase instance. No arguments are required.