Configuration

The module configuration can be done via yaml decoration either by specifying the API key directly in yaml or by providing a path to the API key in passwords app.

  • config.yaml file

  • Configuration app

  • Passwords app

/my-light-module/decorations/openai-automations/config.yaml
apiKey: $OPENAI_API_KEY
jcr config
apiKey: /path/to/apikey

For more, see Passwords app.

Properties

Parameter Description

supportedFieldDefinitions

required

From version 1.0.5

Defines the field types that are going to be filled out during component, variant or page generation. Default is textField, richTextField and damLinkField.

supportedFieldDefinitions:
  textField: textField
  richTextField: richTextField
  damLinkField: damLinkField
Other field types can be configured but might not work as expected.

availableTemplates

optional

From version 1.0.5

Defines the available templates for page generation in general. Availability rules through the site definition are working independently of this configuration.

availableTemplates:
  Basic:
    id: mtk2:pages/basic

availableComponents

optional

From version 1.0.5

Defines the available component templates for page generation and component generation.

availableComponents:
  Link:
    id: mtk2:components/link

Azure OpenAI endpoints

From version 1.0.7

To configure Azure OpenAI endpoints you’ll have to add the following decoration to /my-light-module/decorations/openai-automations/restClients.yaml

/my-light-module/decorations/openai-automations/restClients.yaml
baseUrl: https://<your-openai-deployment>.openai.azure.com/openai/deployments/<your-openai-deployment>
components:
  authorization:
    class: info.magnolia.ai.automations.rest.RestAzureClientAuthorizationFilter
restCalls:
  completions:
    queryParameters:
      api-version: 2023-07-01-preview
  chatCompletions:
    queryParameters:
      api-version: 2023-07-01-preview

Developer samples

Check out some samples here.

Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the AI Accelerator module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules