Package com.sap.ai.sdk.orchestration

Class PromptTemplateReference

java.lang.Object

com.sap.ai.sdk.orchestration.PromptTemplate

com.sap.ai.sdk.orchestration.PromptTemplateReference

public final class PromptTemplateReference
extends PromptTemplate

A reference to a template to use in OrchestrationModuleConfig.

Since:

1.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PromptTemplateReference.ScopeEnum	Enum representing the scope of the template reference.

Nested classes/interfaces inherited from class com.sap.ai.sdk.orchestration.PromptTemplate

PromptTemplate.ReferenceBuilder, PromptTemplate.ReferenceBuilder1, PromptTemplate.ReferenceBuilder2, PromptTemplate.ReferenceBuilder3

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PromptTemplateReference(TemplateRefTemplateRef reference, PromptTemplateReference.ScopeEnum scope, Map<String,String> inputParameters, List<Message> messageHistory)	Creates a new PromptTemplateReference instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,String>	getInputParameters()	Get the placeholder values supplied for this template.
List<Message>	getMessageHistory()	Get the message history to prepend to the conversation for this template.
TemplateRefTemplateRef	getReference()
PromptTemplateReference.ScopeEnum	getScope()	The scope of the template reference.
int	hashCode()
protected PromptTemplatingModuleConfigPrompt	toLowLevel()	Create a low-level representation of the template.
String	toString()
PromptTemplateReference	withInputParameters(Map<String,String> inputParameters)
PromptTemplateReference	withMessageHistory(List<Message> messageHistory)
PromptTemplateReference	withScope(PromptTemplateReference.ScopeEnum scope)	The scope of the template reference.

Methods inherited from class com.sap.ai.sdk.orchestration.PromptTemplate

create, create, fromJson, fromYaml, reference

Methods inherited from class java.lang.Object

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

Constructor Details

PromptTemplateReference

protected PromptTemplateReference(@Nonnull
 TemplateRefTemplateRef reference,
 @Nonnull
 PromptTemplateReference.ScopeEnum scope,
 @Nonnull
 Map<String,String> inputParameters,
 @Nonnull
 List<Message> messageHistory)

Creates a new PromptTemplateReference instance.

Parameters:

reference -

scope - The scope of the template reference.

inputParameters -

messageHistory -

Method Details

toLowLevel

@Nonnull
protected PromptTemplatingModuleConfigPrompt toLowLevel()

Create a low-level representation of the template.

Specified by:

toLowLevel in class PromptTemplate

Returns:

the low-level representation of the template.

getReference

@Nonnull
public TemplateRefTemplateRef getReference()

getScope

@Nonnull
public PromptTemplateReference.ScopeEnum getScope()

The scope of the template reference.

getInputParameters

@Nonnull
public Map<String,String> getInputParameters()

Description copied from class: PromptTemplate

Get the placeholder values supplied for this template.

Specified by:

getInputParameters in class PromptTemplate

Returns:

the placeholder values supplied for this template.

getMessageHistory

@Nonnull
public List<Message> getMessageHistory()

Description copied from class: PromptTemplate

Get the message history to prepend to the conversation for this template.

Specified by:

getMessageHistory in class PromptTemplate

Returns:

the message history for this template.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class PromptTemplate

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class PromptTemplate

hashCode

public int hashCode()

Overrides:

hashCode in class PromptTemplate

withScope

public PromptTemplateReference withScope(@Nonnull
 PromptTemplateReference.ScopeEnum scope)

The scope of the template reference.

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withInputParameters

public PromptTemplateReference withInputParameters(@Nonnull
 Map<String,String> inputParameters)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withMessageHistory

public PromptTemplateReference withMessageHistory(@Nonnull
 List<Message> messageHistory)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).