OpenAI Multimodal Content Generator

generate multimodal content for the user prompt with OpenAI.

Overview

You can use this Snap to generate multimodal content for the user prompt with OpenAI.


OpenAI Multimodal Content Generator Overview

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap supports a maximum of one binary or document input view.
  • Binary Input type: Requires a binary file as an input.
  • Document Input type: Requires a document input, multimodal Content, Content-type and the Type of multimodal content to generate a structured response.
Output This Snap supports at the most one document output view. It outputs a structured response, including sl_type (specifying the modality), sl_contentType (the format of the content), and sl_content (the actual content).
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: OpenAI Multimodal Content Generator

Example: Generate sales graphs
Type Dropdown list

Required. Choose the type of multimodal content to generate. Available options include:

  • image
  • text

Default value: image

Example: text
Content String/Expression

Appears when you select Document as the Input type.

Required. Specify the path to the multimodal content data to be processed.

Default value: N/A

Example: $image
Content type String/Expression

Required. Specify the MIME (Multipurpose Internet Mail Extensions) content type for the multimodal data to be sent to the LLM. Learn more.

Default value: $['content-type'] when input type is Binary

Default value: N/A when input type is Document

Example: image/jpeg
Aggregate input Checkbox/Expression

Select this checkbox to aggregate the input content into a single output document. Selecting this checkbox will no longer make the Snap ultra-compatible.

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: Validate & Execute

Example: Execute only