OpenAI Assistants Tool Call Router

Overview

This Snap routes the input run object into two output views. The first output view passes the run object from the input, which includes the Thread ID and Run ID fields. It also contains an empty array, tool_outputs, which is used to collect tool run results in the downstream Message Appender Snap. The second output view includes the list of tools to be called.


Run Thread Overview

Prerequisites

  • 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 exactly one document input view. You must specify the run object as an input.

Create and Run Thread

Run Thread
Output This Snap has exactly two document output views.
  • The first output view passes the run object from the input, which includes the Thread ID and Run ID fields. It also contains an empty array, tool_outputs, which is used to collect tool run results in the downstream Message Appender Snap.
  • The second output view has a list of tools to call.

Message Appender (First output view)

Binary Router (Second output view)
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 an error occurs.
  • 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: OpenAI Assistants Tool Call Router

Example: Tool Call Router
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: Validate & Execute

Example: Execute only