@bridgeline-digital/hawksearch-handlebars-ui 6.2.0-beta.6 → 6.2.0

package/changelog.md

@@ -1,3 +1,10 @@
+# 6.2.0
+
+## Enhancements
+
+1. Added Conversational Search component `hawksearch-conversationalsearch` that allows thread maintained prompt driven search.
+2. Added SmartResponse component `hawksearch-smartresponse` that allows prompt driven analysis of search results.
+
 # 6.1.13
 
 ## Bug Fixes

package/dist/hawksearch-handlebars-ui.cjs

@@ -1,7 +1,7 @@
 /**
  * name: @bridgeline-digital/hawksearch-handlebars-ui
  *
- * version: v6.2.0-beta.6
+ * version: v6.2.0
  *
  * description: The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by HawkSearch.
  *

package/dist/hawksearch-handlebars-ui.js

@@ -1,7 +1,7 @@
 /**
  * name: @bridgeline-digital/hawksearch-handlebars-ui
  *
- * version: v6.2.0-beta.6
+ * version: v6.2.0
  *
  * description: The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by HawkSearch.
  *

package/dist/hawksearch-handlebars-ui.min.js

@@ -1,7 +1,7 @@
 /**
  * name: @bridgeline-digital/hawksearch-handlebars-ui
  *
- * version: v6.2.0-beta.6
+ * version: v6.2.0
  *
  * description: The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by HawkSearch.
  *

package/dist/hawksearch-handlebars-ui.umd.cjs

@@ -1,7 +1,7 @@
 /**
  * name: @bridgeline-digital/hawksearch-handlebars-ui
  *
- * version: v6.2.0-beta.6
+ * version: v6.2.0
  *
  * description: The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by HawkSearch.
  *

package/dist/index.d.ts

@@ -237,15 +237,37 @@ declare interface ContentZones {
 declare interface ConversationalSearchComponentConfig extends BaseComponentConfig {
     query?: string;
     strings?: {
+        /**
+         * #### Default Value
+         * `Enter a message...`
+         */
         placeholder?: string;
+        /**
+         * #### Default Value
+         * ``
+         */
         resetLabel?: string;
+        /**
+         * #### Default Value
+         * ``
+         */
         sendLabel?: string;
     };
     prompt?: {
+        /**
+         * #### Default Value
+         * `
+         * You are a recommendation agent, specialized in finding the perfect match for a user.
+         * Answer the question from the user extensivelly.
+         * You will be provided with an array of products as DATA.
+         * Create 2 suggested questions that a user could ask about this data that follows.
+         * Use new lines to seperate them. Make them short.
+         * Say something like 'Try one of these suggested questions:' followed by the questions you generate.
+         * Only use the information passed to you as DATA to answer the questions asked.
+         * Do not provide any information on amount of DATA you currently have.
+         * `
+         */
         instructions?: string;
-        schema?: object;
-        onRequest?: any;
-        onResponse?: any;
     };
 }
 
@@ -1303,14 +1325,87 @@ declare interface SizeFacetComponentConfig extends BaseComponentConfig {
 
 declare interface SmartResponseComponentConfig extends BaseComponentConfig {
     strings?: {
+        /**
+         * #### Default Value
+         * `SmartResponse`
+         */
         header?: string;
+        /**
+         * #### Default Value
+         * `No Results found`
+         */
         noresults?: string;
     };
+    /**
+     * Specifies the agent instructions provided to GenAI Bridge
+     */
     prompt?: {
+        /**
+         * #### Default Value
+         * `
+         * You are a recommendation agent, specialized in finding the perfect match for a user.
+         * Answer the question from the user extensivelly.
+         * You will be provided with a user input and an array of products.
+         * Based on the user input and products, determine a maximum of 3 of the most relevant products based on the user input.
+         * Do not provide any information about amount of products you're returning.
+         * `
+         */
         instructions?: string;
+        /**
+         * #### Default Value
+         * `
+         * {
+         *   "name": "smartresponse_summary",
+         *   "description": "Recommedation message and product details which includes name, description, url, price and imageUrl",
+         *   "strict": true,
+         *   "schema": {
+         *       "type": "object",
+         *       "properties": {
+         *           "recommendation": {
+         *               "type": "string"
+         *           },
+         *           "products": {
+         *               "type": "array",
+         *               "items": {
+         *                   "type": "object",
+         *                   "properties": {
+         *                       "name": {
+         *                           "type": "string"
+         *                       },
+         *                       "url": {
+         *                           "type": "string"
+         *                       },
+         *                       "description": {
+         *                           "type": "string"
+         *                       },
+         *                       "price": {
+         *                           "type": "number"
+         *                       },
+         *                       "imageUrl": {
+         *                           "type": "string"
+         *                       }
+         *                   },
+         *                   "required": [
+         *                       "name",
+         *                       "url",
+         *                       "description",
+         *                       "price",
+         *                       "imageUrl"
+         *                   ],
+         *                   "additionalProperties": false
+         *               }
+         *           }
+         *       },
+         *       "required": [
+         *           "recommendation",
+         *           "products"
+         *       ],
+         *       "additionalProperties": false
+         *   }
+         * }
+         * `
+         */
         schema?: object;
-        onRequest?: any;
-        onResponse?: any;
     };
 }
 
@@ -1428,9 +1523,29 @@ declare interface VariantSelectorComponentConfig extends BaseComponentConfig {
 
 declare interface VisualSearchFieldComponentConfig extends BaseComponentConfig {
     strings?: {
+        /**
+         * #### Default Value
+         * `Drag an image here or `
+         * *For more information, see {@link Components}.*
+         */
         dragImageMessage?: string;
+        /**
+         * #### Default Value
+         * `upload an image`
+         * *For more information, see {@link Components}.*
+         */
         uploadImageMessage?: string;
+        /**
+         * #### Default Value
+         * `Drop an image here`
+         * *For more information, see {@link Components}.*
+         */
         dropImageMessage?: string;
+        /**
+         * #### Default Value
+         * `Drop an image here`
+         * *For more information, see {@link Components}.*
+         */
         errorMessage?: string;
     };
 }