Akeneo

https://help.akeneo.com
Admin
Akeneo is an enterprise product information management (PIM) platform that helps businesses manage,...
Tokens:134,848
Snippets:2,396
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Full Prompt Structure Example

Source: https://help.akeneo.com/using-ai-in-the-pim/understanding-the-full-prompt-display

This example illustrates the assembled structure of a full prompt, including system instructions, task details, and placeholders for product information.

```text
# System Instructions

You are a product information manager assistant, and you will be given 
information about a product and a task to perform...

# User Message

Your task is to generate text content for a specific product attribute.

Target attribute information:
- Identifier code: "long_description"
- Descriptive labels: Long description (en_US)

Instructions:
1. Read through the product information thoroughly inside <PRODUCT_INFO>...
2. Look for any mentions of the target attribute...
3. Generate appropriate text content for this attribute...
4. Use the custom user instructions to help you generate the text content...
5. Provide your response in the following language: English (United States).

Additional task-specific instructions from the user:
<CUSTOM_INSTRUCTIONS>
[Your custom instructions appear here]
</CUSTOM_INSTRUCTIONS>

Now, carefully examine the following product information:

<PRODUCT_INFO>
[Product data appears here]
</PRODUCT_INFO>
```

--------------------------------

### Example Naming Convention Configuration

Source: https://help.akeneo.com/serenity-boost-your-productivity/serenity-about-the-product-link-rules

A complete example of a naming convention configuration including source, pattern, and value mappings.

```json
{
          "source": {
            "property": "main_asset_image",
            "channel": null,
            "locale": null
          },
          "pattern": "/(?<product_ref>.*)\_(?<attribute_ref>.*)\_(?<lang>).jpg/",
          "abort_asset_creation_on_error": true,
          "value_mappings": {
    	  	"lang": {
      	  		"target_attribute": "locales_selector",
      	  		"mapped_attribute_ref": "locales_ref",
      	  		"mappings": {
        	  		"de": [
          	  			"de_DE"
        	  		],
        	  		"en": [
          	  			"en_US",
          	  			"en_UK"
        	  		],
        	  		"fr": [
          	  			"fr_FR"
        	  		]
      	  		}
    	  	}
  	  	  }
}
```

--------------------------------

### Naming Convention Configuration Example

Source: https://help.akeneo.com/akeneo-dam-prepare/akeneo-dam-prepare-about-the-product-link-rules

A concrete example of a naming convention configuration using a regex pattern to extract product and attribute references.

```json
{
          "source": {
            "property": "main_asset_image",
            "channel": null,
            "locale": null
          },
          "pattern": "/(?<product_ref>.*)\_(?<attribute_ref>.*)\.jpg/",
          "abort_asset_creation_on_error": true
        }
```

--------------------------------

### Calculate and round price

Source: https://help.akeneo.com/serenity-boost-your-productivity/boost-your-productivity-manage-your-rules

Example showing how to calculate a price in a different currency and scope, with rounding applied to the final result.

```yaml
actions:
              - type: calculate
                round_precision: 0
                destination:
                  field: price
                  scope: ecommerce
                  currency: EUR
                source:
                  field: price
                  scope: ecommerce
                  currency: USD
                operation_list:
                  - operator: multiply
                    field: ratio
```

--------------------------------

### AI Auto-Tagging Instruction Prompt

Source: https://help.akeneo.com/using-ai-in-the-pim/ai-config-with-auto-tagging

Example of a structured prompt used to guide the AI in generating consistent tags for asset images.

```text
Generate descriptive tags focusing on product category, materials, and colors.
Exclude brand names and trademarks. Use lowercase, singular form.
```

--------------------------------

### Comparison of AI Prompt Quality

Source: https://help.akeneo.com/using-ai-in-the-pim/understanding-ai-behavior-and-realistic-use-cases

Examples demonstrating the difference between vague, ineffective prompts and specific, actionable prompts for AI content generation.

```text
"Generate engaging product descriptions using my website data and current market trends. Make sure it sounds nice."
```

```text
"Act as an SEO copywriter. Using the product name, short description, and key features provided, write one 120-word paragraph optimized for search engines. Maintain a friendly and professional tone."
```

--------------------------------

### Remove Category Actions

Source: https://help.akeneo.com/serenity-boost-your-productivity/boost-your-productivity-manage-your-rules

Examples of removing specific categories or categories with their children.

```yaml
actions:
              - type: remove
                  field: categories
                  items:
                    - t-shirts
```

```yaml
actions:
              - type: remove
                  field: categories
                  items:
                    - clothing
                  include_children: true
```

```yaml
actions:
              - type: remove
                  field: categories
                  items:
                    - master
                  include_children: true
```

--------------------------------

### JSON Example: Multiple Transformations (Individual Operations)

Source: https://help.akeneo.com/serenity-manage-your-images-files-assets/18-serenity-about-the-assets-transformations?from_search=178381894

Illustrates various individual asset transformations, including auto crop, aspect ratio adjustment, background removal, thumbnail generation, scaling, colorspace conversion, resolution setting, resizing, and JPEG optimization. Each entry defines a distinct transformation with its specific operation and parameters.

```json
[
  {
    "label": "auto crop",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "autocrop",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "auto_crop",
        "parameters": {}
      }
    ],
    "filename_suffix": "_auto_crop"
  },
  {
    "label": "aspect ratio 2:3",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "aspect_ratio_2_3",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "aspect_ratio",
        "parameters": {
          "aspect_ratio": "2:3"
        }
      }
    ],
    "filename_prefix": "aspect_ratio_2_3_"
  },
  {
    "label": "background removed",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "background_removed",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "remove_background",
        "parameters": {
          "background_color": "transparent",
          "high_precision": true
        }
      }
    ],
    "filename_prefix": "bg_removed_"
  },
  {
    "label": "thumbnail",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "thumbnail",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "thumbnail",
        "parameters": {
          "width": 150,
          "height": 150
        }
      }
    ],
    "filename_prefix": "thumbnail_"
  },
  {
    "label": "scale",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "scale",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "scale",
        "parameters": {
          "ratio": 20
        }
      }
    ],
    "filename_prefix": "scale_"
  },
  {
    "label": "colorspace",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "colorspace",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "colorspace",
        "parameters": {
          "colorspace": "grey"
        }
      }
    ],
    "filename_prefix": "colorspace_"
  },
  {
    "label": "resolution",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "resolution",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "resolution",
        "parameters": {
          "resolution-x": 200,
          "resolution-y": 500,
          "resolution-unit": "ppi"
        }
      }
    ],
    "filename_prefix": "resolution"
  },
  {
    "label": "resize",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "resize",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "resize",
        "parameters": {
          "width": 1000,
          "height": 2000
        }
      }
    ],
    "filename_prefix": "resize"
  },
  {
    "label": "optimize_jpeg",
    "source": {
      "attribute": "media",
      "channel": null,
      "locale": null
    },
    "target": {
      "attribute": "optimize_jpeg",
      "channel": null,
      "locale": null
    },
    "operations": [
      {
        "type": "optimize_jpeg",
        "parameters": {
          "quality": 80
        }
      }
    ],
    "filename_prefix": "optimize_jpeg"
  }
]
```

--------------------------------

### Clear attribute values

Source: https://help.akeneo.com/serenity-boost-your-productivity/boost-your-productivity-manage-your-rules

Examples of using the clear action to remove values from specific attributes, categories, or associations.

```yaml
actions:
            - type: clear
              field: brand
              locale: en_US
```

```yaml
actions:
            - type: clear
              field: categories
```

```yaml
actions:
            - type: clear
              field: associations
```
Tokens:
Raw