From 3ec612153b7eb60249f73d5c4aef79f59eab80b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20D=C4=85browski?= <64841871+dabrt@users.noreply.github.com> Date: Wed, 29 Oct 2025 17:09:59 +0100 Subject: [PATCH 1/6] IBX-10868: Document Anthropic connector --- docs/ai_actions/ai_actions_guide.md | 3 ++- docs/ai_actions/configure_ai_actions.md | 20 ++++++++++++++++++++ docs/ibexa_products/editions.md | 11 ++++++++++- 3 files changed, 32 insertions(+), 2 deletions(-) diff --git a/docs/ai_actions/ai_actions_guide.md b/docs/ai_actions/ai_actions_guide.md index d781341028..2b3ecebcde 100644 --- a/docs/ai_actions/ai_actions_guide.md +++ b/docs/ai_actions/ai_actions_guide.md @@ -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. @@ -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 [[= ibexa_product_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). diff --git a/docs/ai_actions/configure_ai_actions.md b/docs/ai_actions/configure_ai_actions.md index 15caa39816..ba9ad07693 100644 --- a/docs/ai_actions/configure_ai_actions.md +++ b/docs/ai_actions/configure_ai_actions.md @@ -32,6 +32,26 @@ The AI actions come with sample AI action configurations to quickly get you star 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 commands to install the packages: + +`composer require ibexa/connector-anthropic` + +This command adds the feature code, including basic models that let you refine text or generate alternative text for images. + +Once the packages are installed, before you can start using Discounts, you must enable them by following these instructions. + +To use the connector with the Anthropic Claude service, you need to create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) from the Anthropic Claude console, and make sure that you [set up a billing method](https://support.claude.com/en/articles/8325618-paid-plan-billing-faqs). + +Then, in the root folder of your project, modify the `.env` file: find the `ANTHROPIC_API_KEY` variable and replace a placeholder value with the API key that you got from the AI service. + +```bash +###> ibexa/connector-openai ### +ANTHROPIC_API_KEY= +###< ibexa/connector-openai ### +``` + ## Configure access to [[= product_name_connect =]] First, get the credentials by contacting [Ibexa Support](https://support.ibexa.co). diff --git a/docs/ibexa_products/editions.md b/docs/ibexa_products/editions.md index f4aec03e4a..cb3ed4c95b 100644 --- a/docs/ibexa_products/editions.md +++ b/docs/ibexa_products/editions.md @@ -57,4 +57,13 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam | [Storefront](storefront.md) | | | ✔ | | [Transactional emails](transactional_emails.md) | | | ✔ | | [Discounts](discounts.md) | | | ✔ | -| [Symbol attribute type](symbol_attribute_type.md) | ✔ | ✔ | ✔ | \ No newline at end of file +| [Symbol attribute type](symbol_attribute_type.md) | ✔ | ✔ | ✔ | + +## 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--include-snippetslts-update_badgemd-) | ✔ | ✔ | ✔ | From f848633f540db7da2b4199094ed106ee8bcb153b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20D=C4=85browski?= <64841871+dabrt@users.noreply.github.com> Date: Wed, 29 Oct 2025 17:28:03 +0100 Subject: [PATCH 2/6] Fix a broken link to config article --- docs/ai_actions/configure_ai_actions.md | 20 ++++++++++++++------ docs/ibexa_products/editions.md | 2 +- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/ai_actions/configure_ai_actions.md b/docs/ai_actions/configure_ai_actions.md index ba9ad07693..2798baf918 100644 --- a/docs/ai_actions/configure_ai_actions.md +++ b/docs/ai_actions/configure_ai_actions.md @@ -34,22 +34,30 @@ Based on these examples, which reflect the most common use cases, you can learn ## Install Anthropic Claude connector [[% include 'snippets/lts-update_badge.md' %]] -Run the following commands to install the packages: +Run the following command to install the package: `composer require ibexa/connector-anthropic` This command adds the feature code, including basic models that let you refine text or generate alternative text for images. -Once the packages are installed, before you can start using Discounts, you must enable them by following these instructions. +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. -To use the connector with the Anthropic Claude service, you need to create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) from the Anthropic Claude console, and make sure that you [set up a billing method](https://support.claude.com/en/articles/8325618-paid-plan-billing-faqs). +1. Log in to your [Anthropic Claude console](https://console.anthropic.com/login). -Then, in the root folder of your project, modify the `.env` file: find the `ANTHROPIC_API_KEY` variable and replace a placeholder value with the API key that you got from the AI service. +2. In the bottom-left corner, click the key icon to access API keys. + +3. Click **+ Create Key**. + +4. Enter a **Key Name** and click **Add**. + +5. Take a note of the API key, because it is displayed only once. + +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-openai ### +###> ibexa/connector-anthropic ### ANTHROPIC_API_KEY= -###< ibexa/connector-openai ### +###< ibexa/connector-anthropic ### ``` ## Configure access to [[= product_name_connect =]] diff --git a/docs/ibexa_products/editions.md b/docs/ibexa_products/editions.md index cb3ed4c95b..43f4f69abf 100644 --- a/docs/ibexa_products/editions.md +++ b/docs/ibexa_products/editions.md @@ -66,4 +66,4 @@ The features brought by LTS Updates become standard parts of the next LTS releas | Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] | |-----------------|-----------------|-----------------|-----------------| -| [Anthropic Claude connector](configure_ai_actions.md#install-anthropic-claude-connector--include-snippetslts-update_badgemd-) | ✔ | ✔ | ✔ | +| [Anthropic Claude connector](configure_ai_actions.md#install-anthropic-claude-connector) | ✔ | ✔ | ✔ | From c8ef08adad890cbaeb03ed702aa0ce9daffae142 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20D=C4=85browski?= <64841871+dabrt@users.noreply.github.com> Date: Wed, 29 Oct 2025 17:32:25 +0100 Subject: [PATCH 3/6] Typo fix --- docs/ai_actions/ai_actions_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ai_actions/ai_actions_guide.md b/docs/ai_actions/ai_actions_guide.md index 2b3ecebcde..ec65d427bf 100644 --- a/docs/ai_actions/ai_actions_guide.md +++ b/docs/ai_actions/ai_actions_guide.md @@ -35,7 +35,7 @@ To begin using AI Actions, you must first [perform the initial configuration](co ### Prerequisites -Connectors with external AI services delivered by [[= ibexa_product_base =]] require that you first install them, and [configure other settings, such as an API key and billing method](configure_ai_actions.md). +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). From 136d866e3a3bba04723531cb09e2a9941d98c4d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20D=C4=85browski?= <64841871+dabrt@users.noreply.github.com> Date: Thu, 30 Oct 2025 14:14:01 +0100 Subject: [PATCH 4/6] Added default settings override instructions --- docs/ai_actions/ai_actions_guide.md | 2 +- docs/ai_actions/configure_ai_actions.md | 24 +++++++++++++++++++----- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/ai_actions/ai_actions_guide.md b/docs/ai_actions/ai_actions_guide.md index ec65d427bf..8c415d9031 100644 --- a/docs/ai_actions/ai_actions_guide.md +++ b/docs/ai_actions/ai_actions_guide.md @@ -12,7 +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). +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. diff --git a/docs/ai_actions/configure_ai_actions.md b/docs/ai_actions/configure_ai_actions.md index 2798baf918..c55a8c3945 100644 --- a/docs/ai_actions/configure_ai_actions.md +++ b/docs/ai_actions/configure_ai_actions.md @@ -38,17 +38,15 @@ Run the following command to install the package: `composer require ibexa/connector-anthropic` -This command adds the feature code, including basic models that let you refine text or generate alternative text for images. +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). -2. In the bottom-left corner, click the key icon to access API keys. +2. Go to **API keys** and click **Create Key**. -3. Click **+ Create Key**. - -4. Enter a **Key Name** and click **Add**. +4. Select the workspace, enter a **Key Name** and click **Add**. 5. Take a note of the API key, because it is displayed only once. @@ -60,6 +58,22 @@ ANTHROPIC_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). From d2ea8e9f778201c383cc342a7faeb2615ed0e14d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20D=C4=85browski?= <64841871+dabrt@users.noreply.github.com> Date: Thu, 13 Nov 2025 13:31:28 +0100 Subject: [PATCH 5/6] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marek NocoĊ„ --- docs/ai_actions/configure_ai_actions.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/ai_actions/configure_ai_actions.md b/docs/ai_actions/configure_ai_actions.md index c55a8c3945..170a479fe9 100644 --- a/docs/ai_actions/configure_ai_actions.md +++ b/docs/ai_actions/configure_ai_actions.md @@ -36,7 +36,9 @@ Based on these examples, which reflect the most common use cases, you can learn Run the following command to install the package: -`composer require ibexa/connector-anthropic` +``` +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. @@ -58,7 +60,7 @@ ANTHROPIC_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. +By default, when reaching out for responses, the Anthropic connector uses the [Claude Sonnet 4](https://docs.claude.com/en/docs/about-claude/models/overview) model. 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: @@ -73,7 +75,7 @@ ibexa_connector_anthropic: claude-sonnet-4-20250514: 'Claude 4 Sonnet (2025-05-14)' claude-opus-4-20250514: 'Claude Opus 4 (2025-05-14)' ``` - +You can now use the Anthropic connector in your project. ## Configure access to [[= product_name_connect =]] First, get the credentials by contacting [Ibexa Support](https://support.ibexa.co). From b980677fd79173c6b7239533de2d8abc470100ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20D=C4=85browski?= <64841871+dabrt@users.noreply.github.com> Date: Thu, 13 Nov 2025 13:47:12 +0100 Subject: [PATCH 6/6] Reorder features on the editions page --- docs/ibexa_products/editions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ibexa_products/editions.md b/docs/ibexa_products/editions.md index 43f4f69abf..090425c077 100644 --- a/docs/ibexa_products/editions.md +++ b/docs/ibexa_products/editions.md @@ -32,6 +32,7 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam | [Digital Asset Management]([[= user_doc =]]/dam/ibexa_dam/) | ✔ | ✔ | ✔ | | [Product Information Management]([[= user_doc =]]/pim/pim/) | ✔ | ✔ | ✔ | | [Date and time attribute type](date_and_time.md) | ✔ | ✔ | ✔ | +| [Symbol attribute type](symbol_attribute_type.md) | ✔ | ✔ | ✔ | | [Personalization](personalization_guide.md) | ✔ | ✔ | ✔ | | [Migrations](managing_migrations.md) | ✔ | ✔ | ✔ | | [[[= product_name_connect =]]]([[= connect_doc =]]) | ✔ | ✔ | ✔ | @@ -57,7 +58,6 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam | [Storefront](storefront.md) | | | ✔ | | [Transactional emails](transactional_emails.md) | | | ✔ | | [Discounts](discounts.md) | | | ✔ | -| [Symbol attribute type](symbol_attribute_type.md) | ✔ | ✔ | ✔ | ## LTS Updates