OpenAI Assistants

This activity enables the workflow to use the OpenAI Assistants API to build an artificial intelligence (AI) assistant into your workflow. It allows instructions to be sent to the AI, as well as requests which the AI assistant responds to. For more details, refer to the OpenAI Assistants API documentation. To use this activity, a connection must be configured to OpenAI.

Table 1. OpenAI Assistants action - Inputs
Parameters	Description
Connection	Select the OpenAI connections from the drop-down list.
Assistant	Enter the unique identifier for the OpenAI assistant.
Message	Enter the information to be sent to the OpenAI assistant.
ResponseFormat	Enter the instructions sent to OpenAI regarding how the response should be returned. The AI will be told to "Please output response in the format " + ResponseFormat. This is useful when the output needs to be parsed in a specific format.
HTTPRequestURL	If OpenAI returns the response 'requires_action', enter the URL of the HTTP GET request that will be invoked. The response from the HTTP GET request will be returned to OpenAI to continue handling the original request.
Instructions	Enter the training and background information to be sent to the OpenAI assistant.

Table 2. OpenAI Assistants action - Throughputs
Parameters	Description
ThreadId	Enter the identifier of the thread assigned to handle the request. This can be passed into subsequent requests to use the same instance of OpenAI.

Table 3. OpenAI Assistants action - Outputs
Parameters	Description
Response	Response string from OpenAI.
Success	Indicates whether the activity was completed successfully (value = True) or not (value = False).
Output	JSON response from OpenAI.

↑