Download the PHP package sndsabin/module-embedding without Composer
On this page you can find all versions of the php package sndsabin/module-embedding. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sndsabin/module-embedding
More information about sndsabin/module-embedding
Files in sndsabin/module-embedding
Package module-embedding
Short Description This module is responsible to generate the embedding vectors.
License GPL-3.0
Informations about the package module-embedding
Magento2 Module: Embedding
`sndsabin/module-embedding`
- Main Functionality
- Installation
- Configuration
- Generate Product Embedding
- Tested On
Main Functionality
This module generates product embeddings for Magento 2 catalogs using OpenAI-compatible models.
⚠️ This is not a standalone module. It is intended to be used together with a Semantic Search module.
Installation
-
Install the module via composer:
- Enable the module:
Configuration
Navigate to Stores → Configuration → Embedding → Settings
General
- API Key
- Required for most providers
- If your provider does not require a key, enter any placeholder value
Advanced
-
Base URI of Model
- Example:
https://api.openai.com/v1
- Example:
-
Model
- Example:
text-embedding-3-small
- Example:
-
Embedding Dimension
- Example:
1536(fortext-embedding-3-small)
- Example:
-
Index Name
- Example:
product_embedding_v1 - When changing model or dimensions, update index version
(e.g.product_embedding_v1 → product_embedding_v2)
- Example:
- Attributes for Embedding
- Product attributes used to generate embeddings
- Note: Name, SKU, Short Description, and Description are always included
⚠️ After configuration, Generate product embeddings. This process may take some time depending on catalog size.
Generate Product Embedding
1. Queue embedding generation
This command queues embedding jobs for all products.
⚠️ This command is usually run once during initial setup.
Embeddings for new or updated products are generated automatically.
2. Run the consumer
This consumer processes queued messages and generates embeddings. Use cronjob or supervisor to start the consumer.
Tested On:
- Magento 2.4.8
- PHP 8.4
- RabbitMQ 4.1
- OpenSearch 3.3