-
Notifications
You must be signed in to change notification settings - Fork 8
IBX-11004: Describe taxonomy suggestions in user doc #382
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 5.0
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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
|
||||||
|
|
||||||
| 1. Navigate to the Admin Panel and select **AI actions**. | ||||||
|
Check failure on line 110 in docs/ai_actions/work_with_ai_actions.md
|
||||||
|
|
||||||
| 1. In the **AI actions** list, click **Create**. | ||||||
|
Check failure on line 112 in docs/ai_actions/work_with_ai_actions.md
|
||||||
|
|
||||||
| 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** | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **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
|
||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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
|
||||||
|
|
||||||
| 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
|
||||||
| 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
|
||||||
| 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
|
||||||
| 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
|
||||||
|
|
||||||
|  | ||||||
|
|
||||||
| 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
|
||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||
| - Set the maximum number of tokens to be used by each call, and the temperature used when generating suggestions | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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
|
||||||
|
|
||||||
|
|
||||||
| ### 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. | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -90,6 +90,12 @@ | |||||
|
|
||||||
|  | ||||||
|
|
||||||
| !!! note "Taxonomy suggestions" | ||||||
|
Check warning on line 93 in docs/pim/work_with_product_categories.md
|
||||||
|
|
||||||
| 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
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 |
||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### Assign products by editing product category details | ||||||
|
|
||||||
| 1. In the left panel, click **Product catalog** -> **Categories** to navigate to the product category tree. | ||||||
|
|
||||||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as below (and needs to be rephrased for v5)