Embabel Agent Documentation/com.embabel.agent.testing.unit/FakePromptRunner

FakePromptRunner

data class FakePromptRunner(val llm: <Error class: unknown class>?, val toolGroups: Set<ToolGroupRequirement>, val toolObjects: List<ToolObject>, val promptContributors: List<<Error class: unknown class>>, contextualPromptContributors: List<ContextualPromptElement>, val generateExamples: Boolean?, context: OperationContext, _llmInvocations: MutableList<LlmInvocation> = mutableListOf(), responses: MutableList<Any?> = mutableListOf()) : PromptRunner

Constructors

FakePromptRunner

constructor(llm: <Error class: unknown class>?, toolGroups: Set<ToolGroupRequirement>, toolObjects: List<ToolObject>, promptContributors: List<<Error class: unknown class>>, contextualPromptContributors: List<ContextualPromptElement>, generateExamples: Boolean?, context: OperationContext, _llmInvocations: MutableList<LlmInvocation> = mutableListOf(), responses: MutableList<Any?> = mutableListOf())

Properties

generateExamples

open override val generateExamples: Boolean?

Whether to generate examples for the prompt. Defaults to unknown: Set to false if generating your own examples.

open override val llm: <Error class: unknown class>?

val llmInvocations: List<LlmInvocation>

The LLM calls that were made

promptContributors

open val promptContributors: List<<Error class: unknown class>>

open override val toolGroups: Set<ToolGroupRequirement>

Tool groups exposed. This will include directly registered tool groups and tool groups resolved from ToolGroups.

open override val toolObjects: List<ToolObject>

Additional objects with @Tool annotation for use in this PromptRunner

Functions

infix inline fun <T> PromptRunner.create(prompt: String): T

Create an object of the given type. Method overloading is evil

open override fun <T> createObject(prompt: String, outputClass: Class<T>): T

Create an object of the given type using the given prompt and LLM options from context (process context or implementing class). Prompts are typically created within the scope of an

open override fun <T> createObject(messages: List<Message>, outputClass: Class<T>): T

Create an object from messages

infix inline fun <T> PromptRunner.createObject(prompt: String): T

Create an object of the given type

createObjectIfPossible

open override fun <T> createObjectIfPossible(prompt: String, outputClass: Class<T>): T?

Try to create an object of the given type using the given prompt and LLM options from context (process context or implementing class). Prompt is typically created within the scope of an

createObjectIfPossible

inline fun <T> PromptRunner.createObjectIfPossible(prompt: String): T?

open override fun <T> creating(outputClass: Class<T>): ObjectCreator<T>

Create an object creator for the given output class. Allows setting strongly typed examples.

evaluateCondition

open override fun evaluateCondition(condition: String, context: String, confidenceThreshold: <Error class: unknown class>): Boolean

fun expectResponse(response: Any?)

Add a response to the list of expected responses. This is used to simulate responses from the LLM.

open infix fun generateText(prompt: String): String

Generate text

open fun respond(messages: List<Message>): AssistantMessage

Respond in a conversation

withContextualPromptContributor

open fun withContextualPromptContributor(contextualPromptContributor: ContextualPromptElement): PromptRunner

withContextualPromptContributors

open override fun withContextualPromptContributors(contextualPromptContributors: List<ContextualPromptElement>): PromptRunner

Add a prompt contributor that can see context

withGenerateExamples

open override fun withGenerateExamples(generateExamples: Boolean): PromptRunner

Set whether to generate examples of the output in the prompt on a per-PromptRunner basis. This overrides platform defaults.

open override fun withHandoffs(vararg outputTypes: Class<*>): PromptRunner

Add a list of handoffs to agents on this platform

open override fun withLlm(llm: <Error class: unknown class>): PromptRunner

Specify an LLM for the PromptRunner

withPromptContributor

open fun withPromptContributor(promptContributor: <Error class: unknown class>): PromptRunner

Add a prompt contributor that can add to the prompt. Facilitates reuse of prompt elements.

withPromptContributors

open override fun withPromptContributors(promptContributors: List<<Error class: unknown class>>): PromptRunner

withPromptElements

open fun withPromptElements(vararg elements: <Error class: unknown class>): PromptRunner

Add varargs of prompt contributors and contextual prompt elements.

open fun withReference(reference: LlmReference): PromptRunner

Add a reference which provides tools and prompt contribution.

open fun withReferences(vararg references: LlmReference): PromptRunner

Add varargs of references which provide tools and prompt contributions.

open fun withReferences(references: List<LlmReference>): PromptRunner

Add a list of references which provide tools and prompt contributions.

open override fun withSubagents(vararg subagents: Subagent): PromptRunner

Add a list of subagents to hand off to.

withSystemPrompt

open fun withSystemPrompt(systemPrompt: String): PromptRunner

Add a system prompt

open override fun withTemplate(templateName: String): TemplateOperations

Use operations from a given template

open fun withToolGroup(toolGroup: String): PromptRunner

Add a tool group to the PromptRunner

open override fun withToolGroup(toolGroup: ToolGroup): PromptRunner

Allows for dynamic tool groups to be added to the PromptRunner.

open override fun withToolGroup(toolGroup: ToolGroupRequirement): PromptRunner

open fun withToolGroups(toolGroups: Set<String>): PromptRunner

open fun withToolObject(toolObject: Any?): PromptRunner

Add a tool object to the prompt runner.

open override fun withToolObject(toolObject: ToolObject): PromptRunner

Add a tool object

withToolObjects

open fun withToolObjects(vararg toolObjects: Any?): PromptRunner

open fun withTools(vararg toolGroups: String): PromptRunner

Add a set of tool groups to the PromptRunner