Skip to content
Nappai Documentation

OpenAI Tools Agent

This component acts as a helpful assistant within Nappai. It uses OpenAI’s powerful language models and other tools to understand your requests and provide useful responses. It’s like having a personal AI assistant that can access and use various tools to help you.

Relationship with OpenAI

This component directly interacts with OpenAI’s language models and tools. It allows you to leverage the capabilities of these models to perform complex tasks within Nappai’s automation system. You’ll need an active OpenAI account and API key for this component to function correctly.

Inputs

  • Language Model: Select the OpenAI language model you want the assistant to use. This is a required field.
  • System Prompt: This is a general instruction that sets the tone and behavior of the assistant. For example, you could set it to “You are a helpful and concise assistant that provides only factual information.” The default is “You are a helpful assistant”.
  • Prompt: This is your specific request or question for the assistant. It must include the word “input” to work correctly (e.g., “input: What is the weather in London?”). The default is “{input}”.
  • Chat History: (Advanced) This allows you to include previous interactions with the assistant. This helps provide context for your current request. It’s a list of previous questions and answers.

Outputs

This component doesn’t have explicit outputs in the traditional sense. Instead, it creates a “runnable” agent. This agent processes your input (Prompt) and uses the selected Language Model and any other tools you’ve connected to it to generate a response. The response will appear as part of your Nappai workflow.

Usage Example

Let’s say you want to know the current stock price of Apple. You would:

  1. Select a suitable OpenAI language model.
  2. (Optional) Adjust the System Prompt to guide the assistant’s response (e.g., to only provide the price, not a lengthy explanation).
  3. In the Prompt field, enter: input: What is the current stock price of Apple?
  4. Run the workflow. The assistant will use the OpenAI model and potentially other connected tools (like a stock data API) to find and display the answer.

Templates

This component is currently used in the ‘Stock chat’ template.

Many components can be used with the OpenAI Tools Agent to enhance its capabilities. Here are a few examples:

  • Explain SQL results: Use this to get clear explanations of complex database query results.
  • SQL Query Constructor: Use this to build SQL queries for your database.
  • DALL·E Image Generator: Generate images based on text descriptions.
  • Many other components: The OpenAI Tools Agent can be connected to a wide variety of components within Nappai to expand its functionality. Explore the component library to find suitable tools to integrate.

Tips and Best Practices

  • Clear Prompts: The more clearly you state your request, the better the results.
  • System Prompt Tuning: Experiment with different System Prompts to fine-tune the assistant’s behavior.
  • Chat History Usage: Use Chat History to provide context for complex tasks or conversations.
  • Tool Selection: Carefully choose the tools to connect to the agent to ensure it has the resources it needs to complete your requests.

Security Considerations

Ensure your OpenAI API key is kept secure and only accessible to authorized users. Be mindful of the data you share with the OpenAI models, as it may be used to improve their performance. Avoid entering sensitive information unless absolutely necessary.