Free cookie consent management tool by TermsFeed

a!genAiModels() Function

On This Page

Function

Returns a list of the generative AI models that are available for use with AI skills in your environment.

You can use this function to build development and administrative tools that display available generative AI models, helping you manage your AI-powered applications with greater transparency.

The function returns a list of maps, where each map provides metadata like model name and ID of a generative AI model.

Parameters

This function does not have any parameters.

Returns

List of Maps

Each map contains the following keys:

  • name (Text): The display name of the model.
  • id (Text): The unique identifier for the model, prefixed with the provider (for example, appian/ or aws/). Appian GPT models use the appian/openai. prefix.

For example, the function might return the following list:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  a!map(
    name: "Claude Sonnet 4.5",
    id: "appian/anthropic.claude-sonnet-4-5-20250929-v1:0",
  ),
  a!map(
    name: "Claude Haiku 4.5",
    id: "appian/anthropic.claude-haiku-4-5-20251001-v1:0"
  ),
  a!map(
    name: "Amazon Nova 2 Lite",
    id: "appian/amazon.nova-2-lite-v1:0"
  ),
  a!map(
    name: "GPT 5.5",
    id: "appian/openai.gpt-5.5"
  ),
  a!map(
    name: "Claude Sonnet 4.5",
    id: "aws/anthropic.claude-sonnet-4-20250514-v1:0"
  )
}

Considerations

Keep the following points in mind when using this function:

  • The list of available models is specific to the environment where the function is executed.
  • A model only appears in the results if its corresponding provider account is active and the specific model has been enabled by an administrator.
  • If your environment uses a cross-region configuration, the function returns only the generative AI models that are available in the selected region. This includes models natively available in the environment's region and models enabled through inference profiles.
  • Some models require a corresponding inference profile to be configured in the Admin Console. The function only returns these models if an administrator has selected an inference profile, which enables the model for use in the environment.
  • All models count toward AI usage tracking and limits.

Example

This example shows how to use the rich text display component and a!genAiModels() to display available models. This can be useful for developers and administrators to quickly see which models are available in an environment.

1
2
3
4
5
6
7
8
9
a!richTextDisplayField(
  label: "Available Models",
  value: a!richTextBulletedList(
    items: a!forEach(
      items: a!genAiModels(),
      expression: fv!item.name
    )
  )
)

Filter Appian GPT models by ID prefix

This example filters the model list to show only Appian-managed GPT models by matching the appian/openai. prefix in the model ID.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
a!localVariables(
  local!allModels: a!genAiModels(),
  local!appianGptModels: index(
    local!allModels,
    where(
      a!forEach(
        items: local!allModels,
        expression: find("appian/openai.", fv!item.id) = 1
      )
    )
  ),
  a!richTextDisplayField(
    label: "Appian GPT Models",
    value: a!richTextBulletedList(
      items: a!forEach(
        items: local!appianGptModels,
        expression: fv!item.name & " (ID: " & fv!item.id & ")"
      )
    )
  )
)

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Incompatible
Offline Mobile Incompatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

Process Autoscaling Incompatible

Cannot be used in autoscaled processes.

Feedback