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
Binary file added docs/ai_actions/img/taxonomy_source_fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 35 additions & 2 deletions docs/ai_actions/work_with_ai_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,47 @@

1. When ready, toggle the status of the AI action to enabled.

1. In the **Settings** area.
1. Make settings in the **Settings** area.
For a list of available settings, see [Edit existing AI actions](#edit-existing-ai-actions).

1. Click **Save and close** to apply the changes or **Discard** to discard them and close the window.

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/4amA1EL6g3fFxSmQoFCp?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Work with AI actions" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->

## Create AI actions that use [[= product_name_connect =]]
### Create AI actions that control taxonomy suggestions

If the Taxonomy suggestions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.

Check warning on line 108 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L108

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 108, "column": 100}}}, "severity": "WARNING"}

Check warning on line 108 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L108

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 108, "column": 310}}}, "severity": "WARNING"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If the Taxonomy suggestions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.
If the AI Actions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.

Same comment as below (and needs to be rephrased for v5)


1. Navigate to the Admin Panel and select **AI actions**.

Check failure on line 110 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L110

[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/work_with_ai_actions.md", "range": {"start": {"line": 110, "column": 57}}}, "severity": "ERROR"}

1. In the **AI actions** list, click **Create**.

Check failure on line 112 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L112

[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/work_with_ai_actions.md", "range": {"start": {"line": 112, "column": 48}}}, "severity": "ERROR"}

1. In the slide-out pane, make initial choices in the following fields, and click **Create**:

- **Language** - sets the base language for the AI action
- **Action type** - sets an action type to serve as a template for the AI action, for example, **Refine text**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Action type** - sets an action type to serve as a template for the AI action, for example, **Refine text**
- **Action type** - sets an action type to serve as a template for the AI action, for example, **Suggest taxonomy**

- **Action handler** - sets the AI model used to process the requests resulting from this AI action.
Pick `openai-text-to-taxonomy-entries`

Check warning on line 119 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L119

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 119, "column": 43}}}, "severity": "WARNING"}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Pick `openai-text-to-taxonomy-entries`
Pick `taxonomy-text-to-taxonomy`


1. Make settings in the **Global properties** section, as described above.

Check failure on line 121 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L121

[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/work_with_ai_actions.md", "range": {"start": {"line": 121, "column": 74}}}, "severity": "ERROR"}

1. Make settings in the **Settings** area:
1. Select a group of content types that you want to pick content types from.

Check failure on line 124 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L124

[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/work_with_ai_actions.md", "range": {"start": {"line": 124, "column": 80}}}, "severity": "ERROR"}
1. Select the content types in which you want to allow editors to use taxonomy suggestions.

Check failure on line 125 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L125

[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/work_with_ai_actions.md", "range": {"start": {"line": 125, "column": 95}}}, "severity": "ERROR"}
1. Select source fields that contain values to be sent to an AI service for processing.

Check failure on line 126 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L126

[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/work_with_ai_actions.md", "range": {"start": {"line": 126, "column": 91}}}, "severity": "ERROR"}
1. Select target fields for which taxonomy entry suggestions are provided.

Check failure on line 127 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L127

[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/work_with_ai_actions.md", "range": {"start": {"line": 127, "column": 78}}}, "severity": "ERROR"}

![Selecting source fields](img/taxonomy_source_fields.png "Selecting source fields")

1. Make optional settings, for example:
- Define a maximum number of returned suggestions
- Select a prompt and model to be be used for generating suggestions

Check failure on line 133 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L133

[Ibexa.Repetition] Remove this duplicate word: 'be'.
Raw output
{"message": "[Ibexa.Repetition] Remove this duplicate word: 'be'.", "location": {"path": "docs/ai_actions/work_with_ai_actions.md", "range": {"start": {"line": 133, "column": 36}}}, "severity": "ERROR"}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no such configuration
obraz
The model that will be used to calculate embeddings for the text from inputs is set in the configuration.

- Set the maximum number of tokens to be used by each call, and the temperature used when generating suggestions

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Set the maximum number of tokens to be used by each call, and the temperature used when generating suggestions
- Set the maximum number of tokens to be used by each call when generating suggestions


1. Click **Save and close** to apply the changes or **Discard** to discard them and close the window.

Check failure on line 136 in docs/ai_actions/work_with_ai_actions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ai_actions/work_with_ai_actions.md#L136

[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/work_with_ai_actions.md", "range": {"start": {"line": 136, "column": 101}}}, "severity": "ERROR"}


### Create AI actions that use [[= product_name_connect =]]

If your organization uses [[= product_name_connect =]], you can build multi-step scenarios that define the logic needed to process your input data, for example, by merging the output of multiple AI services.
One such example could be sending out a text for translation by one service, and then to another to make sure that the resulting translation is written in the right tone.
Expand Down
9 changes: 8 additions & 1 deletion docs/content_management/create_edit_content_items.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,4 +257,11 @@

![Selecting Taxonomy entries](img/taxonomy_select_taxonomy_entries.png "Selecting Taxonomy entries")

For more information, see [Assign tag to content from taxonomy tree](taxonomy/work_with_tags.md#assign-tag-to-content-from-taxonomy-tree).
!!! note "Taxonomy suggestions"

Check warning on line 260 in docs/content_management/create_edit_content_items.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/create_edit_content_items.md#L260

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/content_management/create_edit_content_items.md", "range": {"start": {"line": 260, "column": 32}}}, "severity": "WARNING"}

If the Taxonomy suggestions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed and configured in your system, instead of manually browsing the taxonomy tree and selecting tags one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.

![Taxonomy entries suggested by the AI Assistant](img/taxonomy_suggestions_content.png "Taxonomy entries suggested by the AI Assistant")


For more information, see [Assign tag to content from taxonomy tree](taxonomy/work_with_tags.md#add-taxonomy-entry-assignment-field-to-content-type).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/content_management/taxonomy/work_with_tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Now, the tag is visible in the taxonomy tree.

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/l7FSQBrnzGvtBgAaicrs?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Add new tag" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->

### Assign tag to content from taxonomy tree
### Add Taxonomy Entry Assignment field to content type

Taxonomy is controlled and configured by the *Taxonomy Entry Assignment* field settings, so you can use multiple fields of this type with different taxonomies, for example, tags and product categories in the same content type.
To be able to assign tags to a Content, first, you need to add a *Taxonomy Entry Assignment* field to the content type definition.
Expand Down
Binary file added docs/pim/img/taxonomy_suggestions_products.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/pim/work_with_product_categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@

![Adding product categories](img/product_category_selection.png "Adding product categories")

!!! note "Taxonomy suggestions"

Check warning on line 93 in docs/pim/work_with_product_categories.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/pim/work_with_product_categories.md#L93

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/pim/work_with_product_categories.md", "range": {"start": {"line": 93, "column": 32}}}, "severity": "WARNING"}

If the Taxonomy suggestions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed and configured in your system, instead of manually browsing the product category tree and selecting categories one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If the Taxonomy suggestions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed and configured in your system, instead of manually browsing the product category tree and selecting categories one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.
If the AI Actions [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) is installed and configured in your system, instead of manually browsing the product category tree and selecting categories one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.

I don' think we're introducing a new LTS Update here, I'd say it's just an extension (feature) to the already existing one. There are no new packages, for example.

BTW: "LTS update" mention is for 4.6 - for v5 this is available out of the box, but needs to be configured and enabled first


![Product categories suggested by the AI Assistant](img/taxonomy_suggestions_products.png "Product categories suggested by the AI Assistant")

### Assign products by editing product category details

1. In the left panel, click **Product catalog** -> **Categories** to navigate to the product category tree.
Expand Down