Sinapsis OpenAI

Templates for seamless integration with OpenAI's powerful APIs

🐍 Installation • 🚀 Features • 📚 Usage example • 🌐 Webapp • 📙 Documentation • 🔍 License

Sinapsis OpenAI provides a powerful and flexible implementation for leveraging OpenAI's APIs. It enables users to easily configure and run various AI tasks including chat completions, audio processing, and image generation/editing.

🐍 Installation

Install using your package manager of choice. We encourage the use of uv

Example with uv:

  uv pip install sinapsis-openai --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-openai --extra-index-url https://pypi.sinapsis.tech

🚀 Features

Templates Supported

This module includes multiple templates tailored for different OpenAI tasks:

• OpenAIChatWrapper: Enables chat completions using OpenAI's chat API, supporting models like GPT-4 and GPT-3.5-turbo.
• OpenAIAudioTranslationWrapper: Translates audio input into text in another language using Whisper models.
• OpenAIAudioTranscriptionWrapper: Converts audio input into text, supporting multiple languages and long audio files.
• OpenAIAudioCreationWrapper: Generates audio from text using speech synthesis with multiple voice options.
• OpenAIImageCreationWrapper: Creates images from text prompts using DALL-E models, with configurable sizes and formats.
• OpenAIImageEditionWrapper: Edits images using OpenAI's image editing API, supporting inpainting and variations.

Tip

Use CLI command sinapsis info --all-template-names to show a list with all the available Template names installed with Sinapsis OpenAI.

🌍 General Attributes

All templates share the following attribute:

• model: Determines which model to use depending on the task chosen.
• openai_init: Dictionary of attributes related to the arguments of the OpenAI client method. Ensure that values are assigned correctly according to the official OpenAI documentation.

Specific Attributes

There are some attributes specific to the templates used:

• OpenAIChatWrapper has one additional attribute:
  • create (dict, optional): Dictionary of attributes related to the arguments of the OpenAI create method. Ensure that values are assigned correctly according to the official OpenAI chat documentation.
• OpenAIAudioTranslationWrapper has one additional attribute:
  • create (dict, optional): Dictionary of attributes related to the arguments of the OpenAI create method. Ensure that values are assigned correctly according to the official OpenAI audio documentation.
• OpenAIAudioTranscriptionWrapper has two additional attributes:
  • create (dict, optional): Dictionary of attributes related to the arguments of the OpenAI create method. Ensure that values are assigned correctly according to the official OpenAI audio documentation.
• OpenAIAudioCreationWrapper has two additional attributes:
  • output_dir (str, optional): Relative path where the binary audio output file will be saved. Defaults to openai/openai_audio.mp4.
  • create (dict, optional): Dictionary of attributes related to the arguments of the OpenAI create method. Ensure that values are assigned correctly according to the official OpenAI audio documentation.
• OpenAIImageCreationWrapper has two additional attributes:
  • response_format (Literal, optional): Specifies the format of the API response. Defaults to url.
  • generate (dict, optional): Dictionary of attributes related to the arguments of the OpenAI generate method. Ensure that values are assigned correctly according to the official OpenAI image documentation.
• OpenAIImageEditionWrapper has three additional attributes:
  • path_to_mask (str, optional): File path to a mask image.
  • path_to_image (str, required): The file path of the original image to be edited. The image is expected to be in png format.
  • edit (dict, optional): Dictionary of attributes related to the arguments of the OpenAI edit method. Ensure that values are assigned correctly according to the official OpenAI image documentation.

Tip

Use CLI command sinapsis info --example-template-config TEMPLATE_NAME to produce an example Agent config for the Template specified in TEMPLATE_NAME.

For example, for OpenAIImageCreationWrapper use sinapsis info --example-template-config OpenAIImageCreationWrapper to produce an example config like:

agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: OpenAIImageCreationWrapper
  class_name: OpenAIImageCreationWrapper
  template_input: InputTemplate
  attributes:
    model: 'dall-e-3'
    response_format: url
    openai_init:
      api_key: null
      organization: null
      project: null
      base_url: null
      websocket_base_url: null
      timeout: 2
      max_retries: 2
      default_headers: null
      default_query: null
      http_client: null
    generate:
      n: 1
      quality: 'standard'
      size: '256x256'
      style: 'vivid'
      user: 'my user'
      extra_headers: null
      extra_query: null
      extra_body: null
      timeout: 2

📚 Usage example

Below is an example YAML configuration for chat completions using OpenAI's GPT-4. In this example, we define an agent named my_test_agent and configure a chat template to process a text input ("What is AI?"). The chat template uses GPT-4 with a temperature of 0.2 and limits the response to a maximum of 60 completion tokens. Environment variables are used for API authentication.

Config

agent:
  name: my_test_agent
  description: "Chat example"

templates:

- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}

- template_name: TextInput
  class_name: TextInput
  template_input: InputTemplate
  attributes:
    text : What is AI?

- template_name: OpenAIChat
  class_name: OpenAIChatWrapper
  template_input: TextInput
  attributes:
    model : gpt-4
    openai_init: {}
    create:
      temperature: 0.2
      max_completion_tokens: 60

This configuration defines an **agent** and a sequence of **templates** to create a chat completion using OpenAI GPT-4.

Important

Attributes specified under the *_init keys (e.g., openai_init) correspond directly to the OpenAi client parameters, while the ones under the create are directly associated to the arguments expected in the create method. Ensure that values are assigned correctly according to the official OpenAI documentation.

The TextInput template correspond to sinapsis-data-readers. If you want to use the example, please make sure you install the package.

To run the config, use the CLI:

sinapsis run name_of_config.yml

🌐 Webapp

The webapp provides a simple interface to generate images using OpenAI's DALL-E 3. Just input your text prompt, and the app will create and display the generated image.

Important

To run the app you first need to clone this repository:

git clone git@github.com:Sinapsis-ai/sinapsis-openai.git
cd sinapsis-openai

Note

If you'd like to enable external app sharing in Gradio, export GRADIO_SHARE_APP=True

Important

You need to set your OpenAI API key, export OPENAI_API_KEY="your-api-key-here"

Tip

To use different prompts, modify the text attribute in the TextInput template within the configuration file config_image_creation.yaml under src/sinapsis_openai/configs. For example:

- template_name: TextInput
  class_name: TextInput
  template_input: InputTemplate
  attributes:
    text: "Your new prompt here"

🐳 Docker

IMPORTANT This docker image depends on the sinapsis:base image. Please refer to the official sinapsis instructions to Build with Docker.

1. Build the sinapsis-openai image:

docker compose -f docker/compose.yaml build

2. Start the app container:

docker compose -f docker/compose_apps.yaml up sinapsis-openai-gradio -d

3. Check the status:

docker logs -f sinapsis-openai-gradio

3. The logs will display the URL to access the webapp, e.g.:

NOTE: The url can be different, check the output of logs

Running on local URL:  http://127.0.0.1:7860

4. To stop the app:

docker compose -f docker/compose_apps.yaml down

💻 UV

To run the webapp using the uv package manager, please:

1. Create the virtual environment and sync the dependencies:

uv sync --frozen

2. Install the wheel:

uv pip install sinapsis-openai[all] --extra-index-url https://pypi.sinapsis.tech

3. Activate the environment:

source .venv/bin/activate

4. Run the webapp:

python webapps/image_creation.py

5. The terminal will display the URL to access the webapp, e.g.:

NOTE: The url can be different, check the output of the terminal

Running on local URL:  http://127.0.0.1:7860

📙 Documentation

Documentation for this and other sinapsis packages is available on the sinapsis website

Tutorials for different projects within sinapsis are available at sinapsis tutorials page

🔍 License

This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.

For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.