Prompt Input Parameters

The majority of the parameters used in the PromptTK SDK’s generatePrompt function are defined in the Prompt Input documentation. Below is a summary of the key parameters you can use when creating a prompt.

Most of these parameters are optional, but providing more context can help the AI generate better responses, something to keep in mind is that these should be describing how our system should craft your prompt, so ensure that the descriptions you provide are descibing how you would like the output of the prompt you receive to be structured.

Parameters

Parameter	Type	Required	Description
mainPrompt	string	Yes	The main prompt or instruction for the AI. This is the core message or question you want the AI to respond to.
endUserDescription	string	No	A description of the end user or audience for the output of the prompt. Helps the AI tailor its response to the intended recipient.
promptSenderDescription	string	No	A description of the sender or author of the prompt. Useful for context about who is asking or providing the prompt.
relationship	string	No	Describes the relationship between the sender and the end user (e.g., teacher-student, manager-employee). Guides the AI’s tone and approach.
mustHaves	string	No	Specific elements or requirements that must be included in the AI’s response.
contextRequirements	string	No	Additional context or background information the AI should consider when generating the response.
lengthRequirements	string	No	Instructions about the desired length of the response (e.g., “one paragraph”, “under 100 words”).
avoidElements	string	No	Elements, topics, or styles the AI should avoid in its response.
styleAndTone	string[]	No	An array of styles or tones to apply (e.g., [“formal”, “friendly”]).
examplePrompts	string	No	Example prompts to help guide the AI in understanding the desired format or intent.
outputType	string	No	The type of output expected (e.g., “summary”, “list”, “code”).
responseFormat	string	No	The format for the response (e.g., “markdown”, “JSON”).
promptGoal	string	No	The goal or objective of the prompt, to help the AI focus its response.
hallucinationControl	string	No	Instructions to minimize or control AI hallucinations (e.g., “only use provided facts”).
projectId	string	No	The project ID to associate the prompt with a specific project in PromptTK.