Embabel Agent Documentation/com.embabel.agent.api.common/PromptRunner/Creating

Creating

interface Creating<T>

Fluent interface for creating strongly-typed objects from LLM responses. Provides configuration options for:

Adding examples
Filtering properties
Enabling/disabling validation

Instances are obtained via PromptRunner.creating.

Parameters

the type of object to create

Inheritors

ObjectCreator

Functions

fromMessages

abstract fun fromMessages(messages: List<Message>): T

Create an object of the desired type from messages.

fromPrompt

open fun fromPrompt(prompt: String): T

Create an object of the desired type using the given prompt and LLM options from context (process context or implementing class). Prompts are typically created within the scope of an @Action method that provides access to domain object instances, offering type safety.

fromTemplate

abstract fun fromTemplate(templateName: String, model: Map<String, Any>): T

Create an object of this type from the given template.

withExample

abstract fun withExample(example: CreationExample<T>): PromptRunner.Creating<T>

open fun withExample(description: String, value: T): PromptRunner.Creating<T>

Add an example of the desired output to the prompt. This will be included in JSON. It is possible to call this method multiple times. This will override PromptRunner.withGenerateExamples

withExamples

open fun withExamples(vararg examples: CreationExample<T>): PromptRunner.Creating<T>

Add multiple examples using vararg syntax. Each example will be added as a prompt contributor to improve LLM output quality.

open fun withExamples(examples: Iterable<CreationExample<T>>): PromptRunner.Creating<T>

Add multiple examples from a list or other iterable. Each example will be added as a prompt contributor to improve LLM output quality.

withoutProperties

open fun withoutProperties(vararg properties: String): PromptRunner.Creating<T>

Exclude the given properties when creating an object.

withoutProperties

fun <T, Any> PromptRunner.Creating<T>.withoutProperties(vararg properties: KProperty1<T, Any>): PromptRunner.Creating<T>

Excludes the given properties when creating an object.

withoutValidation

open fun withoutValidation(): PromptRunner.Creating<T>

Disables validation of created objects.

withProperties

open fun withProperties(vararg properties: String): PromptRunner.Creating<T>

Include the given properties when creating an object.

withProperties

fun <T, Any> PromptRunner.Creating<T>.withProperties(vararg properties: KProperty1<T, Any>): PromptRunner.Creating<T>

Includes the given properties when creating an object.

withPropertyFilter

abstract fun withPropertyFilter(filter: Predicate<String>): PromptRunner.Creating<T>

Add a filter that determines which properties are to be included when creating an object.

withValidation

abstract fun withValidation(validation: Boolean = true): PromptRunner.Creating<T>

Set whether to validate created objects.