Package com.microsoft.semantickernel.semanticfunctions

Interface PromptTemplateFactory

All Known Implementing Classes:

AggregatorPromptTemplateFactory, HandlebarsPromptTemplateFactory, KernelPromptTemplateFactory

public interface PromptTemplateFactory

The interface that a PromptTemplateFactory implementation must provide.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PromptTemplateFactory.UnknownTemplateFormatException	Exception thrown when the template format is not supported.

Method Summary

Modifier and Type	Method	Description
static PromptTemplate	build(PromptTemplateConfig templateConfig)	Create a prompt template, if possible, from the given configuration.
PromptTemplate	tryCreate(PromptTemplateConfig templateConfig)	Create a prompt template, if possible, from the given configuration.

Method Detail

build

static PromptTemplate build(PromptTemplateConfig templateConfig)

Create a prompt template, if possible, from the given configuration. This is a convenience method that wraps the KernelPromptTemplateFactory.tryCreate(PromptTemplateConfig) method.

Parameters:

templateConfig - The configuration for the prompt template.

Returns:

The prompt template.

Throws:

PromptTemplateFactory.UnknownTemplateFormatException - If the template format is not supported.

See Also:

PromptTemplateConfig.getTemplateFormat()

tryCreate

PromptTemplate tryCreate(PromptTemplateConfig templateConfig)

Create a prompt template, if possible, from the given configuration. If the PromptTemplateConfig is not supported, the method should throw an UnknownTemplateFormatException.

Parameters:

templateConfig - The configuration for the prompt template.

Returns:

The prompt template.

Throws:

PromptTemplateFactory.UnknownTemplateFormatException - If the template format is not supported.

See Also:

PromptTemplateConfig.getTemplateFormat()