Create and Run Thread

Overview

You can use this Snap to create a thread and retrieve the result on a specified assistant. This Snap processes the accumulated context and prompts within the thread, calling the specified OpenAI assistant to generate and return the final response.


Create and Run Thread 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 assistant ID 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 status message after running the thread. 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: Create and Run Thread

Example: Embedding data
Assistant ID String/Expression/Suggestion

Required. Specify the ID of the OpenAI Assistant endpoint on which the message should run.

Default value: N/A

Example: asst_kbhNGRZOKjj6ECoz1AtqExDC:SnapQa-Testing01
Prompt String/Expression

Appears when you select Document as the Input type.

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

Default value: N/A

Example: $msg
Polling Configuration Use this field set to define the polling properties. This field set contains the following fields:
Polling interval (ms) String/Expression

Specify the polling interval in milli seconds between the each poll. At each polling interval, the Snap checks the specified source for any new updates.

Default value: 1000

Example: 3000
Polling timeout (ms) String/Expression

Specify the maximum duration for which the Snap will continue to poll for updates or new data before stopping.

Default value: 300000

Example: 600000
Advanced response configurations Configure the response settings to customize the responses and optimize output processing.
Simplify response Checkbox/Expression Select this checkbox to receive the latest message and the run information in a simplified format. Here's an example of a simplified output format.
{
  "id": <string>,
  "assistant_id": <string>,
  "thread_id": <string>,
  "role": <string>,
  "content": <array/string>,
  "finish_reason": <string>,
  "error": <object/null>,
  "usage": {
    "prompt_tokens": <integer>,
    "output_tokens": <integer>,
    "total_tokens": <integer>,
  },
  "_sl_responses": <object of the raw responses for debug mode> //optional
  "original": {}
}
Important: This field does not support upstream values.

Default status: Deselected
Debug mode Checkbox/Expression

Appears when you select Simplify response checkbox.

Select this checkbox to enable debug mode. This mode provides the raw response in the _sl_response field and is recommended for debugging purposes only.

Important: This field does not support upstream values.

Default status: Deselected
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