Description
Scope activity to establish a connection with the OpenAI API. In this scope, further OpenAI activities can be placed.
To use this activity:
- Create a payment plan. See the Billing | Overview page on the Platform OpenAI site for more information: Platform OpenAI Billing overview.
- To set up a bearer token to execute your requests, create a new secret key. See the API keys page on the Platform OpenAI site: Platform OpenAI API keys.
- In RPA Designer, drag the Open AI Scope activity into the workflow.
- In the Select or create Variable field, enter the bearer token and
click Okay.
In production environments, we recommend using the Get Password and Username activity to store the token.
Note: For testing purposes, instead of using the bearer token, you can enter the following string in the Input Expression field:new System.Net.NetworkCredential(string.Empty, "special-key").SecurePassword
Properties
Analyst
- Description: Optional text for documentation purposes.
Common
-
Continue On Error: Continues the execution of the workflow even if an error occurs during the execution of the activity.
-
Delay Before: Delay time in milliseconds before the activity is executed. The default value is 250 milliseconds.
-
Delay After: Delay time in milliseconds after executing of the activity. The default value is 250 milliseconds.
-
Disable Log: Disables the logging functionality for this activity.
-
Disable Protocol: Disables the protocol functionality for this activity.
-
Exclude from Global Delay: Excludes this activity from the Global Delay functionality.
-
Timeout: Duration in milliseconds in which the activity tries to execute.
Input
- Bearer Token: The API key that is used for authentication.
- Existing Connection: Existing connection that can be retrieved from another OpenAI Scope activity.
- Organization: The organization to use for API requests.
- User: A unique identifier representing your end user, which can help OpenAI to monitor and detect abuse.
Output [Expert]
-
Connection: Optional output of the connection.
If this property is set, use the Dispose activity to close the connection later.
If this property is not set, the OpenAI Scope activity will close the connection automatically.