Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/ai_actions/ai_actions_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Wherever you look, artificial intelligence becomes more and more important by en
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.

Out-of-the-box, AI Actions solution includes two essential components: a framework package and an OpenAI connector package.
The Anthropic Claude connector is also available - as an [LTS update](editions.md#lts-updates).

AI Actions can integrate with [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/), to give you an opportunity to build complex data transformation workflows without having to rely on custom code.
From the developer's perspective, the integration removes the burden of maintaining third-party AI handlers, and accelerates the deployment of AI-based solutions.
Expand All @@ -34,7 +35,7 @@ To begin using AI Actions, you must first [perform the initial configuration](co

### Prerequisites

The OpenAI connector requires that you first [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) and make sure that you [set up a billing method](https://help.openai.com/en/articles/9038407-how-can-i-set-up-billing-for-my-account).
Connectors with external AI services delivered by [[= product_name_base =]] require that you first install them, and [configure other settings, such as an API key and billing method](configure_ai_actions.md).

Integration with [[= product_name_connect =]] requires that you first [get the credentials]([[= connect_doc =]]/general/ibexa_connect/#access-ibexa-connect) to your account, and the [API token](configure_ai_actions.md#create-token).

Expand Down
42 changes: 42 additions & 0 deletions docs/ai_actions/configure_ai_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,48 @@

Based on these examples, which reflect the most common use cases, you can learn to configure your own AI actions with greater ease.

## Install Anthropic Claude connector [[% include 'snippets/lts-update_badge.md' %]]

Run the following command to install the package:

`composer require ibexa/connector-anthropic`

This command adds the feature code, including basic handlers that let you refine text or generate alternative text for images.

To use the connector with the Anthropic Claude service, you need to create an account, make sure that you [set up a billing method](https://support.claude.com/en/articles/8325618-paid-plan-billing-faqs), and get an API key.

1. Log in to your [Anthropic Claude console](https://console.anthropic.com/login).

Check failure on line 45 in docs/ai_actions/configure_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/configure_ai_actions.md#L45

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/ai_actions/configure_ai_actions.md", "range": {"start": {"line": 45, "column": 82}}}, "severity": "ERROR"}

2. Go to **API keys** and click **Create Key**.

Check failure on line 47 in docs/ai_actions/configure_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/configure_ai_actions.md#L47

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/ai_actions/configure_ai_actions.md", "range": {"start": {"line": 47, "column": 47}}}, "severity": "ERROR"}

4. Select the workspace, enter a **Key Name** and click **Add**.

Check failure on line 49 in docs/ai_actions/configure_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/configure_ai_actions.md#L49

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/ai_actions/configure_ai_actions.md", "range": {"start": {"line": 49, "column": 64}}}, "severity": "ERROR"}

5. Take a note of the API key, because it is displayed only once.

Check failure on line 51 in docs/ai_actions/configure_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/configure_ai_actions.md#L51

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/ai_actions/configure_ai_actions.md", "range": {"start": {"line": 51, "column": 65}}}, "severity": "ERROR"}

Then, in the root folder of your project, modify the `.env` file: add an `ANTHROPIC_API_KEY` variable and populate its value with the API key that you got from the AI service.

```bash
###> ibexa/connector-anthropic ###
ANTHROPIC_API_KEY=<your_api_key>
###< ibexa/connector-anthropic ###
```

By default, when reaching out for responses, the Anthropic connector requests that [Claude Sonnet 4](https://docs.claude.com/en/docs/about-claude/models/overview) model is used.
Users can override this setting at runtime when they [edit or create an AI action]([[= user_doc =]]/ai_actions/work_with_ai_actions/#edit-existing-ai-actions).
You can also change the default values globally.
To do it, in `config/packages` folder, create a YAML file similar to this example:

```yaml
ibexa_connector_anthropic:
text_to_text:
default_model: claude-opus-4-20250514
default_temperature: 0.8
default_max_tokens: 2045
models:
claude-sonnet-4-20250514: 'Claude 4 Sonnet (2025-05-14)'
claude-opus-4-20250514: 'Claude Opus 4 (2025-05-14)'
```

## Configure access to [[= product_name_connect =]]

First, get the credentials by contacting [Ibexa Support](https://support.ibexa.co).
Expand Down
11 changes: 10 additions & 1 deletion docs/ibexa_products/editions.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,13 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
| [Storefront](storefront.md) | | | &#10004; |
| [Transactional emails](transactional_emails.md) | | | &#10004; |
| [Discounts](discounts.md) | | | &#10004; |
| [Symbol attribute type](symbol_attribute_type.md) | &#10004; | &#10004; | &#10004; |
| [Symbol attribute type](symbol_attribute_type.md) | &#10004; | &#10004; | &#10004; |

## LTS Updates

LTS Updates are opt-in packages that bring additional features to the [LTS releases](release_process_and_roadmap.md#long-term-support-releases) that they enhance.
The features brought by LTS Updates become standard parts of the next LTS release.

| Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
|-----------------|-----------------|-----------------|-----------------|
| [Anthropic Claude connector](configure_ai_actions.md#install-anthropic-claude-connector) | &#10004; | &#10004; | &#10004; |
Loading