OpenAI Prompt Activity¶
This activity can be configured to use one of these OpenAI models:
Create an OpenAI Prompt Activity¶
An instance of an OpenAI Prompt activity is created from an OpenAI connection using its Prompt activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.
An existing OpenAI Prompt activity can be edited from these locations:
- The design canvas (see Component Actions Menu in Design Canvas).
- The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
Configure an OpenAI Prompt Activity¶
Follow these steps to configure an OpenAI Prompt activity:
Step 1: Enter a Name and Specify Settings
Provide a name for the activity and specify the prompt text and optional settings.
Step 2: Review the Data Schemas
Any request or response schemas are displayed.
Step 1: Enter a Name and Specify Settings¶
In this step, provide a name for the activity and specify the prompt text and optional settings. Each user interface element of this step is described below.
Name: Enter a name to identify the activity. The name must be unique for each OpenAI Prompt activity and must not contain forward slashes
Prompt Text: Enter the prompt to be used for the completions.
Optional Settings: Click to expand additional optional settings:
Temperature: Enter the sampling temperature. The value must be a decimal between
2. It is not recommended to use this setting with Top Probability.
Max Tokens: Enter the maximum number of tokens to be used.
Top Probability: Enter the top probability. It is not recommended to use this setting with Temperature.
Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Review the Data Schemas¶
Any request or response schemas are displayed. Each user interface element of this step is described below.
Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.
Data supplied in a transformation takes precedence over the activity configuration.
The OpenAI connector uses the OpenAI API. Refer to the API documentation for information on the schema nodes and fields.
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the OpenAI endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Edit: Click the edit icon above each data schema to enter the editor for that data schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to
[0, 1]cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
After configuring an OpenAI Prompt activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.
OpenAI Prompt activities can be used as a target with these operation patterns:
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.