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.
- This is a Transform-type Snap.
Works in Ultra Tasks
Prerequisites
None.
Limitations and known issues
None.
Snap views
| Type | 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. | |
| Learn more about Error handling. | ||
Snap settings
- 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.
| 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. You can click
This improves for agentic-operations coming from sub-agents for Agent Visualizer. |
|
| 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 displayed, however, appears as null in the output.
Default value: N/A Example: value1 |
| Snap execution | Dropdown list |
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Validate & Execute Example: Execute only |
to display the 