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.

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.

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

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

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