OpenAI v2.0.0

About the connector

This integration supports interacting with OpenAI's powerful language model, ChatGPT from FortiSOAR workflows.

This document provides information about the OpenAI connector, which facilitates automated interactions, using the OpenAI API. Add the OpenAI connector as a step in FortiSOAR™ playbooks and perform automated operations such as conversing with OpenAI, retrieving a list of available models from OpenAI, etc.

NOTE: For optimal results from the OpenAI connector, use it in conjunction with the 'Fortinet Advisor' solution pack. For more information, see the Fortinet Advisor solution pack documentation.

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 7.4.3

OpenAI Version Tested on: v1
NOTE: The OpenAI connector v2.0.0 and higher is compatible with the OpenAI Python dependency version 1.0.0 or higher. Also, this version of the connector has been tested on the following gpt models: gpt-3.5-turbo, gpt-3.5-turbo-0301, gpt-4, and gpt-4-1106-preview.

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

The following enhancements are made to the OpenAI connector in version 2.0.0:

• Added the following new actions and playbooks:
  • Converse With OpenAI
  • List Available Models
  • Get Tokens Usage
  • Get Token Count
• Renamed the Create a chat completion action and playbook to Ask a Question and updated the output schema for this action.
• Added the following input parameters to the Ask a Question and Converse With OpenAI actions:
  • Timeout
  • Additional Inputs
• Updated the output schema for the following actions:
  • Ask a Question
  • Converse With OpenAI
  • List Available Models
  • Get Tokens Usage
• Enhanced connector to be able to connect to Azure OpenAI Service. A new configuration parameter named 'Use Microsoft Azure OpenAI Endpoint' is added for users who want to use OpenAI services via a Microsoft Azure Endpoint.

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:
yum install cyops-connector-openai

Prerequisites to configuring the connector

• You must have the API key to connect and perform automated operations on the OpenAI server.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the OpenAI server.

Minimum Permissions Required

• Not applicable.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Content Hub page, click the Manage tab, and then click the OpenAI connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™:

operation: Ask a Question

Input parameters

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "model": "",
    "usage": {
        "total_tokens": "",
        "prompt_tokens": "",
        "completion_tokens": ""
    },
    "object": "",
    "choices": [
        {
            "index": "",
            "message": {
                "role": "",
                "content": "",
                "tool_calls": "",
                "function_call": ""
            },
            "finish_reason": ""
        }
    ],
    "created": "",
    "system_fingerprint": ""
}

operation: Converse With OpenAI

Input parameters

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "model": "",
    "usage": {
        "total_tokens": "",
        "prompt_tokens": "",
        "completion_tokens": ""
    },
    "object": "",
    "choices": [
        {
            "index": "",
            "message": {
                "role": "",
                "content": "",
                "tool_calls": "",
                "function_call": ""
            },
            "finish_reason": ""
        }
    ],
    "created": "",
    "system_fingerprint": ""
}

operation: List Available Models

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "data": [
        {
            "id": "",
            "object": "",
            "created": "",
            "owned_by": ""
        }
    ],
    "object": ""
}

operation: Get Tokens Usage

Input parameters

Output

The output contains the following populated JSON schema:

{
    "data": [
        {
            "user_id": "",
            "operation": "",
            "n_requests": "",
            "snapshot_id": "",
            "organization_id": "",
            "aggregation_timestamp": "",
            "n_context_tokens_total": "",
            "n_generated_tokens_total": ""
        }
    ],
    "object": "",
    "ft_data": [],
    "dalle_api_data": [],
    "whisper_api_data": []
}

operation: Get Token Count

Input parameters

Output

The output contains the following populated JSON schema:

{
    "tokens": ""
}

Included playbooks

The Sample - OpenAI - 2.0.0 playbook collection comes bundled with the OpenAI connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the OpenAI connector.

• Ask a Question
• Converse With OpenAI
• Get Token Count
• Get Tokens Usage
• List Available Models

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets overwritten during the connector upgrade and gets deleted during connector uninstall.