Input Connector Nodes
      Back to home
      1. Home
      2. 5: Workflow Toolkit
      3. Input Connector Nodes

      OpenAI Connector

      This document serves as a comprehensive guide on how to use the OpenAI Connector effectively for chat and various operational tasks. If you have any further questions or require additional assistance

      Overview

      The OpenAI Connector enables you to automate tasks within OpenAI and integrate its capabilities with other applications. This document outlines the various operations supported by OpenAI, focusing on chat functionality and the management of assistants.

      Credentials

      Before using the OpenAI Connector, ensure that you have set up your OpenAI credentials. Refer to OpenAI's documentation for guidance on authentication.

      Operations

      1. OpenAI Assistant Management

      Manage your OpenAI assistants with the following operations:

      • Create an Assistant

        • Set up a new AI assistant tailored to your needs.

      • Delete an Assistant

        • Remove an existing assistant that you no longer require.

      • List Assistants

        • Retrieve a list of all assistants you have created in your OpenAI account.

      • Message an Assistant

        • Interact with a specific assistant to receive responses based on your queries.

      • Update an Assistant

        • Modify the settings or parameters of an existing assistant.

      2. Messaging Models

      Utilize OpenAI's chat capabilities to interact with various models:

      • Message a Model

        • Send a message to an OpenAI model and receive a generated response.

      • Classify Text for Violations

        • Analyze text to identify potential violations or inappropriate content.

      3. Image Operations

      Work with images through the following operations:

      • Analyze Image

        • Assess an image for content or features based on the OpenAI model's capabilities.

      • Generate an Image

        • Create images using OpenAI's image generation features.

      4. Audio Operations

      Interact with audio files with these functionalities:

      • Generate Audio

        • Produce audio content based on input specifications.

      • Transcribe Audio

        • Convert spoken language in audio files into text.

      • Translate Audio

        • Translate spoken audio from one language to another.

      5. File Management

      Manage files within OpenAI:

      • Delete a File

        • Remove a file from your OpenAI account.

      • List Files

        • Retrieve a list of files stored in your OpenAI account.

      • Upload a File

        • Add files to your OpenAI account for further processing.

      Related Resources

      For more detailed information about OpenAI services and capabilities, refer to the following links:

      Handling Rate Limits

      For assistance with managing rate limits during API calls, refer to OpenAI's guidelines on handling rate limits to ensure optimal use of the service.


      Authentication Guide

      OpenAI provides a range of services that can be accessed through its API, allowing users to leverage advanced language models, embeddings, and chat functionalities. To interact with these services, users must authenticate using OpenAI credentials.

      Prerequisites

      Before you can use OpenAI's API, you need to create an OpenAI account. This account will enable you to generate the necessary credentials for accessing OpenAI's services.

      Supported Authentication Methods

      OpenAI supports the following authentication method for API access:

      • API Key: This is the primary method for authenticating requests to the OpenAI API.

      Generating Your API Key

      To configure your OpenAI credentials, follow these steps to obtain your API key:

      1. Create an OpenAI Account:

        • If you do not have an OpenAI account, visit the OpenAI website and sign up.

      2. Login to Your Account:

        • Access your OpenAI account by logging in with your credentials.

      3. Access API Keys:

        • Navigate to the API keys page in your account settings.

      4. Create a New API Key:

        • Click on the option to "Create new secret key." You may choose to give your key a descriptive name for future reference.

      5. Copy Your API Key:

        • Once the key is generated, copy it. You will need to add this key when configuring your OpenAI integration.

      Organization ID

      If you are part of multiple organizations within OpenAI, you will also need an Organization ID to ensure that your API requests are correctly attributed. If you only belong to a single organization, you can leave this field blank.

      To Find Your Organization ID:

      1. Go to Organization Settings:

        • Access the Organization Settings page in your OpenAI account.

      2. Copy Your Organization ID:

        • Locate the Organization ID listed on this page and copy it for use in your API requests.

      Note: API requests made using an Organization ID will count toward that organization’s subscription quota.

      Related Resources

      For more detailed information about OpenAI’s API services and capabilities, refer to the following resources:

       

      How to Use the HTTP Request Node

      What is HTTP?

      HTTP (Hypertext Transfer Protocol) is the foundation of data communication on the World Wide Web. The HTTP Request Node in Rayven enables sending data from Rayven.io to web servers or other platforms through API calls or webhooks. It facilitates integration with web-based services and cloud systems, allowing seamless data exchange.

      How to Use

      Implementation

      In the Rayven Workflow Builder:

      1. Select Outputs: Navigate to the Outputs section in the workflow.
      2. Drag the HTTP Output Node: Drag and drop the HTTP Output node onto the canvas.
      3. Open Configuration Window: Double-click on the HTTP Output node to open the configuration settings.

      Configuration

      Section: General This section includes the basic configuration elements required for the HTTP Output Node:

      Field Requirement Comments
      Node Name Mandatory Enter a name for this node. This name should be simple yet meaningful to explain the node’s purpose.
      URL Mandatory Enter the URL of the web API you want to call.
      Output Format Mandatory Select the output format from the dropdown list:
          - JSON
          - XML
          - String

      Sending Data

      The HTTP Output Node allows you to transmit data to external systems in various formats, including JSON, XML, or as a plain string. This capability enhances the interoperability between different applications or services, allowing for real-time communication and data exchange.

      By leveraging the HTTP Output Node, you can integrate with external APIs or web services, enabling further processing, analysis, or visualization of your data.




      This document serves as a comprehensive guide on how to use the OpenAI Connector effectively for chat and various operational tasks. If you have any further questions or require additional assistance, please feel free to reach out!