PromptOpenAI 2025.3.28.13-SNAPSHOT¶
BUNDLE¶
com.snowflake.openflow.runtime | runtime-openai-nar
DESCRIPTION¶
Sends a prompt to OpenAI, writing the response either as a FlowFile attribute or to the contents of the incoming FlowFile. The prompt may consist of pure text interaction or may include images. In the case of images, a URL may be provided, or the contents of the FlowFile may be used, depending on the provided configuration
INPUT REQUIREMENT¶
REQUIRED
Supports Sensitive Dynamic Properties¶
false
PROPERTIES¶
Property |
Description |
|---|---|
Detail Level |
The image detail level that OpenAI should use for processing the image. Low detail will be less expensive and lower latency, while a high level may provide better results. |
Image MIME Type |
The MIME type of the image |
Image Model Name |
The name of the OpenAI model |
Image URL |
The URL of the image to send to OpenAI. If not specified, the contents of the FlowFile will be used as the image. |
Max File Size |
The maximum size of a FlowFile that can be sent to OpenAI as an image. If the FlowFile is larger than this, it will be routed to ‘failure’. |
Max Tokens |
The maximum number of tokens to generate |
OpenAI API Key |
The API Key for authenticating to OpenAI |
OpenAI Organization |
The organization to use for OpenAI |
Prompt Type |
The type of prompt to send to OpenAI |
Response Format |
The format of the response from OpenAI |
Results Attribute |
The name of the attribute to write the response to. If unset, the response will be written to the FlowFile content. |
Seed |
The seed to use for generating the response |
System Message |
The system message to send to OpenAI. FlowFile attributes may be referenced via Expression Language, and the contents of the FlowFile may be referenced via the flowfile_content variable. E.g., ${flowfile_content} |
Temperature |
The temperature to use for generating the response. |
Text Model Name |
The name of the OpenAI model |
Top P |
The top P value to use for generating the response |
User |
Your end user, sent to OpenAI for monitoring and detection of abuse |
User Message |
The user message to send to OpenAI. FlowFile attributes may be referenced via Expression Language, and the contents of the FlowFile may be referenced via the flowfile_content variable. E.g., ${flowfile_content} |
Web Client Service |
The Web Client Service to use for communicating with OpenAI |
RELATIONSHIPS¶
NAME |
DESCRIPTION |
|---|---|
failure |
If unable to obtain a valid response from OpenAI, the original FlowFile will be routed to this relationship |
success |
The response from OpenAI is routed to this relationship |