OpenAI Assistant

​

Node Details

• Name: openAIAssistant
• Type: OpenAIAssistant
• Category: [[Agents]]
• Version: 4.0

​

Parameters

1. Select Assistant (Required)

   • Type: asyncOptions
   • Description: Allows selection of a pre-configured OpenAI Assistant.
   • Load Method: listAssistants

2. Allowed Tools (Required)

   • Type: Tool[]
   • Description: A list of tools that the assistant can use to perform tasks or gather information.

3. Input Moderation (Optional)

   • Type: Moderation[]
   • Description: Moderation tools to detect and prevent harmful input.

4. Tool Choice (Optional)

   • Type: string
   • Description: Controls which tool is called by the model. Can be “none”, “auto”, “required”, or a specific tool name.
   • Additional Params: true

5. Parallel Tool Calls (Optional)

   • Type: boolean
   • Default: true
   • Description: Whether to enable parallel function calling during tool use.
   • Additional Params: true

6. Disable File Download (Optional)

   • Type: boolean
   • Description: Prevents downloading of files included in messages.
   • Additional Params: true

​

Input

• A string containing the user’s message or query.

​

Output

An object containing:

• text: The assistant’s response
• usedTools: An array of tools used by the assistant
• artifacts: Any generated artifacts (e.g., images)
• fileAnnotations: Information about files referenced in the response
• assistant: Details about the assistant session (assistantId, threadId, runId, messages)

​

How It Works

1. The node initializes with a selected OpenAI Assistant and configured tools.
2. It receives user input, which may be moderated if specified.
3. The assistant processes the input, potentially using tools and accessing its knowledge base.
4. It generates a response, which may include text, file references, or generated artifacts.
5. The node manages the conversation thread, allowing for context retention across multiple interactions.

​

Use Cases

• Complex, multi-turn conversational AI systems
• Task-oriented assistants with tool-using capabilities
• Information retrieval and analysis from large datasets
• Creative content generation (text, images)
• Educational tutoring systems
• Customer support automation

​

Special Features

• OpenAI Assistant Integration: Leverages the full capabilities of OpenAI’s Assistant API.
• Tool Usage: Can use a variety of tools to enhance its capabilities.
• File Handling: Ability to work with and reference files in conversations.
• Conversation Threading: Maintains context over multiple interactions.
• Moderation: Optional input moderation for safe interactions.
• Parallel Tool Execution: Can run multiple tools simultaneously for efficiency.