Augmentation interface
An augmentation is a component that can be added to a prompt template to add additional functionality to the prompt.
- Extends
-
PromptResponseValidator<TContent>
Methods
| create |
Creates a plan given validated response value. |
| create |
Creates an optional prompt section for the augmentation. |
Inherited Methods
| validate |
Validates a response to a prompt. |
Method Details
createPlanFromResponse(TurnContext, Memory, PromptResponse<TContent>)
Creates a plan given validated response value.
function createPlanFromResponse(context: TurnContext, memory: Memory, response: PromptResponse<TContent>): Promise<Plan>Parameters
- context
-
TurnContext
Context for the current turn of conversation.
- memory
- Memory
An interface for accessing state variables.
- response
-
PromptResponse<TContent>
The validated and transformed response for the prompt.
Returns
Promise<Plan>
The created plan.
createPromptSection()
Creates an optional prompt section for the augmentation.
function createPromptSection(): undefined | PromptSectionReturns
undefined | PromptSection
Inherited Method Details
validateResponse(TurnContext, Memory, Tokenizer, PromptResponse<string>, number)
Validates a response to a prompt.
function validateResponse(context: TurnContext, memory: Memory, tokenizer: Tokenizer, response: PromptResponse<string>, remaining_attempts: number): Promise<Validation<TContent>>Parameters
- context
-
TurnContext
Context for the current turn of conversation with the user.
- memory
- Memory
An interface for accessing state values.
- tokenizer
- Tokenizer
Tokenizer to use for encoding and decoding text.
- response
-
PromptResponse<string>
Response to validate.
- remaining_attempts
-
number
Number of remaining attempts to validate the response.
Returns
Promise<Validation<TContent>>
A Validation object.
Inherited From PromptResponseValidator.validateResponse