Add Message

Overview

You can use this Snap to add messages to an existing thread. After creating a thread, this Snap appends additional prompts or questions, builds up the context, and prepares detailed input before calling the AI assistant for further processing.


Add Message Overview

Prerequisites

Deploy the specific model in the Azure OpenAI Studio portal. Learn more about the access to Azure OpenAI.

Limitations and known issues

None

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at the most one binary or document input view. This Snap requires a prompt message and thread ID to which the prompt needs to be appended. Mapper
Output This Snap has at the most one document output view. It provides the clear confirmation and relevant details about the added prompt. 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:

  • Stop Pipeline Execution Stops the current pipeline execution when the Snap encounters an error.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (Plus Icon): Indicates that you can add fields in the field set.
  • Remove icon (Minus Icon): Indicates that you can remove fields from the field set.
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: Add Message

Example: Add Message 1
Thread ID String/Expression Required. Specify the ID of the thread to which the message should be added.

Default value: N/A

Example: thread_2K1FOXw8xEVfJwpmgIj4scwn
Prompt String/Expression

Appears when you select Document as the Input type.

Required. Specify the prompt to send to the assistant endpoint as the user message.

Default value: N/A

Example: $msg
Snap execution Dropdown list
Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.

Default value: Execute Only

Example: Validate & Execute