Azure OpenAI Prompt Generator
Overview
You can use this Snap to generate the user prompt as specified in the prompt template using the mustache template.
Format-type Snap
Works in Ultra Tasks
Prerequisites
None.
Limitations and known issues
None.
Snap views
| View | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input | This Snap has at the most one document output view. The Snap requires a prompt template. | Mapper |
| Output | This Snap supports at the most one binary or document input view. The Snap provides the augmented user prompt which is the combination of the user prompt and relevant context in the prompt template. | Mapper |
| Error |
Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
|
Snap settings
- Expression icon (
): JavaScript
syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If
disabled, you can provide a static value. Learn more. - SnapGPT (
): Generates SnapLogic Expressions
based on natural language using SnapGPT. Learn
more. - Suggestion icon (
): Populates a
list of values dynamically based on your Account configuration. - Upload
: Uploads files. Learn more.
| Field / field set | Type | Description |
|---|---|---|
| Label | String |
Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline. Default value: Azure OpenAI Prompt Generator Example: Azure OpenAI Prompt Generator |
| Prompt template | Dropdown list |
Select the template to build the final prompt. The available option is Context Q & A.
This Snap supports variable replacement through a mustache on the input document.
Note: To reset the Prompt template to the default settings, click the Edit prompt and then click Generate Template.
Default value: Context Q & A |
| Edit prompt | Button |
In the Edit prompt window, configure the prompt details to generate a user prompt. |
| Advanced prompt output | Checkbox |
Select this checkbox to output the entire prompt message array instead of the individual prompt message. Default status: Deselected |
| User role | Dropdown list/Expression |
Appears when you select the Advanced prompt output checkbox. Required. Choose the role to use for the prompt. Available
options include:
Default value: USER Example: ASSISTANT |
| User name | String/Expression |
Appears when you select the Advanced prompt output checkbox. Specify an optional name to use for the prompt. If you leave this field blank, the Snap processes the request without using any name. Default value: N/A Example: sl-user |
| Content | String/Expression |
Appears when you select Advanced prompt output checkbox and USER in the User role field. Specify the multimodal content to be used in the prompt. Default value: N/A Example: $content |
| Snap execution | Dropdown list |
Select one of the three modes in which the Snap executes.
Available options are:
Default value: Validate & Execute Example: Execute only |