Merge pull request #4571 from vespa-engine/sebastiannberg/combined-ecom

Author: sebastiannberg

_data/sidebar.yml

@@ -471,6 +471,8 @@ docs:
             url: /en/modules/e-commerce/multi-currency-filtering.html
           - page: Saved Search Notifications
             url: /en/modules/e-commerce/saved-search.html
+          - page: Using Features Together
+            url: /en/modules/e-commerce/using-features-together.html
 
   - title: Reference
     documents:

en/modules/e-commerce/multi-currency-filtering.html

@@ -133,7 +133,7 @@ <h3 id="configure-services">Configure Services</h3>
     <chain id="forex-cache" inherits="vespa" />
 </search>
 
-<component id="ai.vespa.ecommerce.multicurrency.ForexRateService"
+<component id="ai.vespa.ecommerce.common.ForexRateService"
            class="ai.vespa.ecommerce.multicurrency.CachedForexRateService"
            bundle="ecommerce-multi-currency" />
 
@@ -172,7 +172,7 @@ <h3 id="configure-services">Configure Services</h3>
       </chain>
       <chain id="forex-cache" inherits="vespa" />
     </search>
-    <component id="ai.vespa.ecommerce.multicurrency.ForexRateService"
+    <component id="ai.vespa.ecommerce.common.ForexRateService"
                class="ai.vespa.ecommerce.multicurrency.CachedForexRateService"
                bundle="ecommerce-multi-currency" />
     <component id="ai.vespa.ecommerce.multicurrency.ForexRateRetriever"
@@ -475,7 +475,8 @@ <h2 id="advanced-usage">Advanced Usage</h2>
 <h3 id="custom-field-configuration">Custom Field Configuration</h3>
 <p>
   By default, the multi-currency components expect specific field names in your product schema.
-  You can customize these field names using the <code>product-schema-wiring</code> configuration.
+  You can customize these field names using the <code>ecommerce-schema-wiring</code> configuration.
+  See <a href="#configuration">Configuration Reference</a> for all available parameters and their defaults.
 </p>
 
 <pre>{% highlight xml %}
@@ -484,7 +485,7 @@ <h3 id="custom-field-configuration">Custom Field Configuration</h3>
         <chain id="multi-currency-filter" inherits="vespa">
             <searcher id="ai.vespa.ecommerce.multicurrency.MultiCurrencyFilterSearcher"
                       bundle="ecommerce-multi-currency">
-                <config name="ai.vespa.ecommerce.multicurrency.product-schema-wiring">
+                <config name="ai.vespa.ecommerce.common.ecommerce-schema-wiring">
                     <productFields>
                         <sellerCurrency>seller_currency</sellerCurrency>
                         <perMarketPriceArrayStruct>per_market_price</perMarketPriceArrayStruct>
@@ -504,18 +505,6 @@ <h3 id="custom-field-configuration">Custom Field Configuration</h3>
 </container>
 {% endhighlight %}</pre>
 
-<p>
-  Configuration parameters:
-</p>
-<ul>
-  <li><code>productFields.sellerCurrency</code> - Field name for the product's seller currency (default: <code>seller_currency</code>)</li>
-  <li><code>productFields.perMarketPriceArrayStruct</code> - Array field name containing per-market prices (default: <code>per_market_price</code>)</li>
-  <li><code>productFields.marketStructField</code> - Struct field name for market code (default: <code>market</code>)</li>
-  <li><code>productFields.priceStructField</code> - Struct field name for price value (default: <code>price</code>)</li>
-  <li><code>defaults.market</code> - Default market identifier used as fallback (default: <code>DEFAULT</code>)</li>
-  <li><code>rankProfileInputs.forexRates</code> - Query tensor name for forex rates in ranking (default: <code>forexRates</code>)</li>
-</ul>
-
 
 <h3 id="using-forex-in-ranking">Using Forex Rates in Ranking</h3>
 <p>
@@ -642,6 +631,65 @@ <h4 id="complete-ranking-query">Complete Query with Filtering and Ranking</h4>
 </ul>
 
 
+<h2 id="configuration">Configuration Reference</h2>
+
+<p>
+  This section describes the <a href="../../applications/configuring-components.html">configuration parameters</a>
+  used by the multi-currency components.
+  All parameters are part of the <code>ecommerce-schema-wiring</code> config
+  (<code>ai.vespa.ecommerce.common.ecommerce-schema-wiring</code>).
+</p>
+
+<table class="table">
+  <thead>
+    <tr>
+      <th>Parameter</th>
+      <th>Description</th>
+      <th>Type</th>
+      <th>Default</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>productFields.sellerCurrency</code></td>
+      <td>Field name for the product's seller currency.</td>
+      <td><code>string</code></td>
+      <td><code>seller_currency</code></td>
+    </tr>
+    <tr>
+      <td><code>productFields.perMarketPriceArrayStruct</code></td>
+      <td>Array field name containing per-market prices.</td>
+      <td><code>string</code></td>
+      <td><code>per_market_price</code></td>
+    </tr>
+    <tr>
+      <td><code>productFields.marketStructField</code></td>
+      <td>Struct field name for market code.</td>
+      <td><code>string</code></td>
+      <td><code>market</code></td>
+    </tr>
+    <tr>
+      <td><code>productFields.priceStructField</code></td>
+      <td>Struct field name for price value.</td>
+      <td><code>string</code></td>
+      <td><code>price</code></td>
+    </tr>
+    <tr>
+      <td><code>defaults.market</code></td>
+      <td>Default market identifier used as fallback when no market-specific price exists.</td>
+      <td><code>string</code></td>
+      <td><code>DEFAULT</code></td>
+    </tr>
+    <tr>
+      <td><code>rankProfileInputs.forexRates</code></td>
+      <td>Query tensor name for forex rates in ranking. Used when <code>enrich=true</code> to inject the forex tensor into the query.</td>
+      <td><code>string</code></td>
+      <td><code>forexRates</code></td>
+    </tr>
+  </tbody>
+</table>
+
+
 <h2 id="requirements">Requirements</h2>
 <ul>
   <li>
@@ -687,6 +735,8 @@ <h2 id="recommended-practices">Recommended Practices</h2>
 
 <h2 id="see-also">See Also</h2>
 <ul>
+  <li><a href="saved-search.html">Saved Search Notifications</a></li>
+  <li><a href="using-features-together.html">Using Features Together</a></li>
   <li><a href="../../learn/tutorials/e-commerce">E-commerce tutorial</a></li>
   <li><a href="../../applications/searchers.html">Searcher Development</a></li>
   <li><a href="../../ranking/tensor-user-guide.html">Tensor Guide</a></li>

en/modules/e-commerce/saved-search.html

@@ -14,7 +14,7 @@
 <h2 id="overview">Overview</h2>
 
 <p>
-  The ecommerce-saved-search module supports:
+  The saved search notifications feature supports:
 </p>
 <ul>
   <li><strong>Storing predicate queries</strong> - Saved searches contain arbitrary boolean expressions over a set of string attributes and numerical ranges. See <a href="../../schemas/predicate-fields.html">Predicate Fields</a>.</li>
@@ -107,7 +107,7 @@ <h3 id="configure-services">Configure Services</h3>
             <chain id="notification">
                 <documentprocessor id="ai.vespa.ecommerce.savedsearch.SavedSearchDocumentProcessor" 
                                    bundle="ecommerce-saved-search" />
-                <config name="ai.vespa.ecommerce.savedsearch.schema-wiring">
+                <config name="ai.vespa.ecommerce.common.ecommerce-schema-wiring">
                     <notification>
                         <kind>WEBHOOK</kind>
                         <webhook>
@@ -118,7 +118,7 @@ <h3 id="configure-services">Configure Services</h3>
                     <itemDocumentType>product</itemDocumentType>
                     <savedSearchDocumentType>saved_search</savedSearchDocumentType>
                     <predicateFieldName>filters</predicateFieldName>
-                    <savedSearchNumHits>10</savedSearchNumHits>
+                    <savedSearchNumHits>100</savedSearchNumHits>
 
                     <regularAttributes>
                         <item>
@@ -279,7 +279,7 @@ <h4 id="notification-security">Security</h4>
     ...
     <documentprocessor id="ai.vespa.ecommerce.savedsearch.SavedSearchDocumentProcessor" 
                        bundle="ecommerce-saved-search" />
-    <config name="ai.vespa.ecommerce.savedsearch.schema-wiring">
+    <config name="ai.vespa.ecommerce.common.ecommerce-schema-wiring">
         <notification>
             <kind>WEBHOOK</kind>
             <webhook>
@@ -356,7 +356,7 @@ <h4 id="notification-vespa-example">Notification example</h4>
 <container>
     <documentprocessor id="ai.vespa.ecommerce.savedsearch.SavedSearchDocumentProcessor" 
                        bundle="ecommerce-saved-search" />
-    <config name="ai.vespa.ecommerce.savedsearch.schema-wiring">
+    <config name="ai.vespa.ecommerce.common.ecommerce-schema-wiring">
         <notification>
             <kind>VESPA_SCHEMA</kind>
             <vespaSchema>
@@ -517,3 +517,14 @@ <h2 id="configuration">Configuration reference</h2>
     </tr>
   </tbody>
 </table>
+
+
+<h2 id="see-also">See Also</h2>
+<ul>
+  <li><a href="../../schemas/predicate-fields.html">Predicate Fields</a></li>
+  <li><a href="../../applications/document-processors.html">Document Processors</a></li>
+  <li><a href="../../applications/configuring-components.html">Configuring Components</a></li>
+  <li><a href="../../security/secret-store.html">Secret Store</a></li>
+  <li><a href="multi-currency-filtering.html">Multi-Currency Pricing</a></li>
+  <li><a href="using-features-together.html">Using Features Together</a></li>
+</ul>