Add Message (Not Recommended)

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 (Not Recommended) Overview

Prerequisites

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

Limitations and known issues

None.

Snap views

Type 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

Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using 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 Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field/Field set Type Description

Label

String

 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 (Not Recommended)

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

Appears only when you select Document as the Input type and in the default state (0 minimum input).

Required. Specify the prompt to run against the assistant.

Default value: N/A

Example: $msg
Snap execution

Dropdown list

 Dropdown list
Choose 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