Package com.sap.ai.sdk.prompt.registry.model

Class SingleChatTemplate

java.lang.Object

com.sap.ai.sdk.prompt.registry.model.SingleChatTemplate

All Implemented Interfaces:

PromptTemplate

public class SingleChatTemplate
extends Object
implements PromptTemplate

SingleChatTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SingleChatTemplate.Builder	Builder helper class.
static interface	SingleChatTemplate.Builder1	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SingleChatTemplate	content(String content)	Set the content of this SingleChatTemplate instance and return the same instance.
static SingleChatTemplate.Builder	create()	Create a type-safe, fluent-api builder object to construct a new SingleChatTemplate instance with all required arguments.
boolean	equals(Object o)
String	getContent()	Get content
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the SingleChatTemplate.
String	getRole()	Get role
int	hashCode()
SingleChatTemplate	role(String role)	Set the role of this SingleChatTemplate instance and return the same instance.
void	setContent(String content)	Set the content of this SingleChatTemplate instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this SingleChatTemplate instance.
void	setRole(String role)	Set the role of this SingleChatTemplate instance.
Map<String,Object>	toMap()	Get the value of all properties of this SingleChatTemplate instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SingleChatTemplate

protected SingleChatTemplate()

Default constructor for SingleChatTemplate.

Method Details

role

@Nonnull
public SingleChatTemplate role(@Nonnull
 String role)

Set the role of this SingleChatTemplate instance and return the same instance.

Parameters:

role - The role of this SingleChatTemplate

Returns:

The same instance of this SingleChatTemplate class

getRole

@Nonnull
public String getRole()

Get role

Returns:

role The role of this SingleChatTemplate instance.

setRole

public void setRole(@Nonnull
 String role)

Set the role of this SingleChatTemplate instance.

Parameters:

role - The role of this SingleChatTemplate

content

@Nonnull
public SingleChatTemplate content(@Nonnull
 String content)

Set the content of this SingleChatTemplate instance and return the same instance.

Parameters:

content - The content of this SingleChatTemplate

Returns:

The same instance of this SingleChatTemplate class

getContent

@Nonnull
public String getContent()

Get content

Returns:

content The content of this SingleChatTemplate instance.

setContent

public void setContent(@Nonnull
 String content)

Set the content of this SingleChatTemplate instance.

Parameters:

content - The content of this SingleChatTemplate

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the SingleChatTemplate.

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 SingleChatTemplate 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 SingleChatTemplate 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 SingleChatTemplate 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 SingleChatTemplate.Builder create()

Create a type-safe, fluent-api builder object to construct a new SingleChatTemplate instance with all required arguments.