Add Message

Overview

You can use this Snap to add a message to the specified thread. You can also append more prompts to the thread to prepare context or questions before calling the assistant to run.


Add Message Overview

Prerequisites

  • Valid OpenAI API key with appropriate permissions.
  • Access to the OpenAI Assistants API endpoints.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap supports a maximum of one binary or document input view. You must provide thread ID and prompt to add the user message to a thread.

Mapper

Union
Output This Snap has a maximum of one document output view. The Snap provides the result generated by the create message API.

Mapper

Filter
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 (): Indicates that you can add fields in the field set.
  • Remove 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: OpenAI Add Message
Thread ID String/Expression

Required. Specify the ID of the thread.

Default value: N/A

Example: thread_jkdhjkdhkdfkdfjvfkvf
Prompt String/Expression

Required. Specify the prompt to run against the assistant.

Note: This field does not appear when you select Binary as the Input type.

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

Troubleshooting

Thread ID is a required attribute.

Thread ID is mandatory to run a thread.

Specify the thread ID.

Examples