OpenAI Function Result Generator

Overview

You can use this Snap to format the results generated by user-run functions into a unified structure within SnapLogic.


OpenAI Function Result Generator

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at the most one document input view, which is the output of a tool.
Output This Snap has at the most one document output view. It is a tool result that conforms to SnapLogic's internal format.
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

Legend:
  • Expression icon (): 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 Account configuration.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
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 Function Result Generator

Example: Generate function results for AI models.
Function ID String/Expression Required. Specify the function ID that is generated by the model when requesting a tool call. It serves to identify which function was called to produce the result.

Default value: N/A

Example: call_Nk86vkUKPP3IcTt7RxTTKZOq
Content String/Expression Required. Specify the output of a tool run that will be sent to the AI model for processing, which provides additional information for model to answer the original prompt.

Default value: N/A

Example: Example data or input for the function.

Metadata Use this field set to configure the metadata associated with the function result. The metadata is not sent to the model in the tool calling Snaps; instead, it is passed downstream for further use. For example, you could add a log field as metadata to pass the tool execution log downstream. Learn more about how the tool calling Snap parses the message payload.
Key String/Expression Specify the key to use for the metadata. If the metadata key is empty, the Snap displays an error.

Default value: N/A

Example: key1
Value String/Expression Specify the value to use for the metadata. If the metadata value is empty, no error is diplayed, however, appears as null in the output.

Default value: N/A

Example: value1
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

Examples