Skip to content

Commit ca3e822

Browse files
dabrtmnocon
andauthored
IBX-10868: Document Anthropic connector (#2942)
* IBX-10868: Document Anthropic connector * Fix a broken link to config article * Typo fix * Added default settings override instructions * Apply suggestions from code review Co-authored-by: Marek Nocoń <[email protected]> * Reorder features on the editions page * Renamed to Antropic connector --------- Co-authored-by: Marek Nocoń <[email protected]>
1 parent 097c09a commit ca3e822

File tree

3 files changed

+56
-2
lines changed

3 files changed

+56
-2
lines changed

docs/ai_actions/ai_actions_guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Wherever you look, artificial intelligence becomes more and more important by en
1212
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.
1313

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

1617
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.
1718
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
3435

3536
### Prerequisites
3637

37-
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).
38+
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).
3839

3940
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).
4041

docs/ai_actions/configure_ai_actions.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,50 @@ The AI actions come with sample AI action configurations to quickly get you star
3232

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

35+
## Install Anthropic connector [[% include 'snippets/lts-update_badge.md' %]]
36+
37+
Run the following command to install the package:
38+
39+
``` bash
40+
composer require ibexa/connector-anthropic
41+
```
42+
43+
This command adds the feature code, including basic handlers that let you refine text or generate alternative text for images.
44+
45+
To use the connector with the Anthropic services, 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.
46+
47+
1. Log in to your [Anthropic Claude console](https://console.anthropic.com/login).
48+
49+
2. Go to **API keys** and click **Create Key**.
50+
51+
4. Select the workspace, enter a **Key Name** and click **Add**.
52+
53+
5. Take a note of the API key, because it is displayed only once.
54+
55+
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.
56+
57+
```bash
58+
###> ibexa/connector-anthropic ###
59+
ANTHROPIC_API_KEY=<your_api_key>
60+
###< ibexa/connector-anthropic ###
61+
```
62+
63+
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.
64+
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).
65+
You can also change the default values globally.
66+
To do it, in `config/packages` folder, create a YAML file similar to this example:
67+
68+
```yaml
69+
ibexa_connector_anthropic:
70+
text_to_text:
71+
default_model: claude-opus-4-20250514
72+
default_temperature: 0.8
73+
default_max_tokens: 2045
74+
models:
75+
claude-sonnet-4-20250514: 'Claude 4 Sonnet (2025-05-14)'
76+
claude-opus-4-20250514: 'Claude Opus 4 (2025-05-14)'
77+
```
78+
You can now use the Anthropic connector in your project.
3579
## Configure access to [[= product_name_connect =]]
3680
3781
First, get the credentials by contacting [Ibexa Support](https://support.ibexa.co).

docs/ibexa_products/editions.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
3232
| [Digital Asset Management]([[= user_doc =]]/dam/ibexa_dam/) | &#10004; | &#10004; | &#10004; |
3333
| [Product Information Management]([[= user_doc =]]/pim/pim/) | &#10004; | &#10004; | &#10004; |
3434
| [Date and time attribute type](date_and_time.md) | &#10004; | &#10004; | &#10004; |
35+
| [Symbol attribute type](symbol_attribute_type.md) | &#10004; | &#10004; | &#10004; |
3536
| [Personalization](personalization_guide.md) | &#10004; | &#10004; | &#10004; |
3637
| [Migrations](managing_migrations.md) | &#10004; | &#10004; | &#10004; |
3738
| [[[= product_name_connect =]]]([[= connect_doc =]]) | &#10004; | &#10004; | &#10004; |
@@ -57,4 +58,12 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
5758
| [Storefront](storefront.md) | | | &#10004; |
5859
| [Transactional emails](transactional_emails.md) | | | &#10004; |
5960
| [Discounts](discounts.md) | | | &#10004; |
60-
| [Symbol attribute type](symbol_attribute_type.md) | &#10004; | &#10004; | &#10004; |
61+
62+
## LTS Updates
63+
64+
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.
65+
The features brought by LTS Updates become standard parts of the next LTS release.
66+
67+
| Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
68+
|-----------------|-----------------|-----------------|-----------------|
69+
| [Anthropic connector](configure_ai_actions.md#install-anthropic-connector) | &#10004; | &#10004; | &#10004; |

0 commit comments

Comments
 (0)