UserInputMessage class
A section capable of rendering user input text and images as a user message.
- Extends
Constructors
| User |
Creates a new 'UserInputMessage' instance. |
Inherited Properties
| required | If true the section is mandatory otherwise it can be safely dropped. |
| separator | |
| text |
|
| tokens | The requested token budget for this section.
|
Inherited Methods
| get |
Returns the content of a message as a string. |
| render |
Renders the prompt section as a string of text. |
Constructor Details
UserInputMessage(number, string, string)
Creates a new 'UserInputMessage' instance.
new UserInputMessage(tokens?: number, inputVariable?: string, filesVariable?: string)Parameters
- tokens
-
number
Optional. Sizing strategy for this section. Defaults to auto.
- inputVariable
-
string
Optional. Name of the variable containing the user input text. Defaults to input.
- filesVariable
-
string
Optional. Name of the variable containing the user input files. Defaults to inputFiles.
Inherited Property Details
required
If true the section is mandatory otherwise it can be safely dropped.
required: booleanProperty Value
boolean
Inherited From PromptSectionBase.required
separator
textPrefix
tokens
The requested token budget for this section.
- Values between 0.0 and 1.0 represent a percentage of the total budget and the section will be layed out proportionally to all other sections.
- Values greater than 1.0 represent the max number of tokens the section should be allowed to consume.
tokens: numberProperty Value
number
Inherited From PromptSectionBase.tokens
Inherited Method Details
getMessageText(Message<string>)
Returns the content of a message as a string.
static function getMessageText(message: Message<string>): stringParameters
- message
-
Message<string>
Message to get the text of.
Returns
string
The message content as a string.
Inherited From PromptSectionBase.getMessageText
renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number)
Renders the prompt section as a string of text.
function renderAsText(context: TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: Tokenizer, maxTokens: number): Promise<RenderedPromptSection<string>>Parameters
- context
-
TurnContext
Context for the current turn of conversation.
- memory
- Memory
Interface for accessing state variables.
- functions
- PromptFunctions
Functions for rendering prompts.
- tokenizer
- Tokenizer
Tokenizer to use for encoding/decoding text.
- maxTokens
-
number
Maximum number of tokens allowed for the rendered prompt.
Returns
Promise<RenderedPromptSection<string>>
The rendered prompt section.
Inherited From PromptSectionBase.renderAsText