Firebase

Overview

The OpenAI Plugin allows you to seamlessly integrate OpenAI's powerful language model into Varolio's automations. By leveraging OpenAI's advanced natural language processing capabilities, you can easily perform tasks such as text generation, summarization, translation, and more. This document provides information on how to authenticate and use the plugin, as well as details on the available functions and fields you need to fill to create OpenAI node in your automations..

Authentication Guide

To use the OpenAI Plugin, users must first obtain an API key. Follow these steps to receive your API key:

(Insert gif: Obtaining OpenAI API Key)

Step 1: Visit the OpenAI Website

Visit the OpenAI website (https://www.openai.com/) and sign up for an account or log in to your existing account.

Step 2: Navigate to API Keys

Navigate to the "View API Keys" section under your account settings.

Step 3: Generate a New API Key

Generate a new API key by clicking on the "Create new secret Key" button.

Step 4: Copy the API Key

Copy the generated API key.

Step 5: Connect to Varolio

In Varolio, navigate to the "Connections" section, and choose the OpenAI plugin.

Step 6: Add the API Key to Varolio

Choose a name for the connection and paste the copied API key into the designated API Key field and press the "Connect".

The Functions

The OpenAI Plugin provides the following actions and triggers:

  • Text Generation: Generate text based on a given prompt.

  • Text Summarization: Summarize long pieces of text into shorter, concise summaries.

  • Language Translation: Translate text from one language to another.

  • Sentiment Analysis: Determine the sentiment of a given text (positive, negative, or neutral).

  • Text Extraction: Extract specific information from unstructured text data.

For each action, the following data is provided to you:

  • Generated text, summary, or translation

  • Sentiment classification

  • Extracted data

The Fields

You need to fill in the following fields for each function:

Text Generation:

  • Display Name: The name you want to set for the node.

  • Input prompt: The text or question you want the model to generate a response for.

  • Model: The specific OpenAI model to be used (e.g., GPT-4).

  • Max tokens: The maximum number of tokens (words) in the generated response.

Text Summarization:

  • Display Name: The name you want to set for the node.

  • Input text: The long text to be summarized.

  • Model: The specific OpenAI model to be used.

  • Max tokens: The maximum number of tokens (words) in the generated summary.

Language Translation:

  • Display Name: The name you want to set for the node.

  • Input text: The text to be translated.

  • Source language: The language the input text is written in (e.g., 'en' for English).

  • Target language: The language you want the text translated into (e.g., 'es' for Spanish).

Sentiment Analysis:

  • Display Name: The name you want to set for the node.

  • Input text: The text for which you want to determine the sentiment.

Text Extraction:

  • Display Name: The name you want to set for the node.

  • Input text: The text containing the information you want to extract.

  • Extraction type: The type of information you want to extract (e.g., dates, names, email addresses).

Last updated