Deployed 7772e2f with MkDocs version: 1.6.1

index.html

@@ -275,6 +275,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#purpose-and-goals" class="md-nav__link">
+    <span class="md-ellipsis">
+      Purpose and Goals
+    </span>
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -367,6 +376,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#purpose-and-goals" class="md-nav__link">
+    <span class="md-ellipsis">
+      Purpose and Goals
+    </span>
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -399,6 +417,10 @@
 <h1 id="user-behavior-insights">User Behavior Insights</h1>
 <h2 id="welcome-to-user-behavior-insights-ubi">Welcome to User Behavior Insights (UBI)!</h2>
 <p>UBI is a <a href="standard/">data standard</a> along with a collection of <a href="tools/">tools and search engine plugins</a> created to help search engineers gain and utilize an improved understanding of users' actions.</p>
+<h2 id="purpose-and-goals">Purpose and Goals</h2>
+<p>Many Search teams struggle with understanding "Why is my user doing this". They have great understanding of an incoming query and the documents returned, but no ability to connect that dot with an indicator of success, such as a click through event or add to cart event.</p>
+<p>There are A LOT of tools out there for tracking events, Google Analytics, Snowplow, etc, but each is a bit different, and each tends to lock you in. None of them think about the needs of Search teams specifically either.</p>
+<p>The User Behavior Insights standard attempts to provide a search focused standard that can operate across many platforms. There are implementations for</p>
 <h2 id="reference-implementation">Reference Implementation</h2>
 <p>A full reference implementation using OpenSearch is available at <a href="https://github.com/o19s/chorus-opensearch-edition">chorus-opensearch-edition</a>.</p>
 

search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"User Behavior Insights","text":""},{"location":"#welcome-to-user-behavior-insights-ubi","title":"Welcome to User Behavior Insights (UBI)!","text":"<p>UBI is a data standard along with a collection of tools and search engine plugins created to help search engineers gain and utilize an improved understanding of users' actions.</p>"},{"location":"#reference-implementation","title":"Reference Implementation","text":"<p>A full reference implementation using OpenSearch is available at chorus-opensearch-edition.</p>"},{"location":"standard/","title":"User Behavior Insights Standard","text":"<p>The most important part of UBI is its standard that defines how queries and user events are defined.</p> <ul> <li>UBI Standard</li> </ul>"},{"location":"tools/","title":"Tools and Plugins","text":"<p>There are several available tools and plugins supporting UBI.</p> <ul> <li>OpenSearch UBI plugin</li> <li>Elasticsearch UBI Plugin</li> </ul>"},{"location":"tools/#ubi-plugin-for-opensearch","title":"UBI Plugin for OpenSearch","text":"<p>The OpenSearch UBI plugin facilitates persisting client-side events (e.g. item clicks, scroll depth) and OpenSearch queries for the purpose of analyzing the data to improve search relevance and user experience. The concepts of UBI and this plugin project was originally proposed in the OpenSearch UBI RFC.</p> <p>To use the plugin, first download the release appropriate for your version of OpenSearch. Next, install the plugin:</p> <pre><code>bin/opensearch-plugin install file:/opensearch-ubi-1.0.0-os2.14.0.zip\n</code></pre> <p>With the plugin installed, you can now capture OpenSearch queries:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>And you can send client-side events to OpenSearch:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>To see these events, check the <code>ubi_queries</code> and <code>ubi_events</code> indexes:</p> <pre><code>curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n</code></pre>"},{"location":"tools/#ubi-plugin-for-elasticsearch","title":"UBI Plugin for Elasticsearch","text":"<p>The Elasticsearch UBI Plugin is a fork of the OpenSearch UBI plugin. This plugin provides similar core functionality but other functionality will differ.</p> <p>To use the plugin, first download the release appropriate for your version of Elasticsearch. Next, install the plugin:</p> <pre><code>bin/elasticsearch-plugin install file:/elasticsearch-ubi-1.0.0-es2.14.0.zip\n</code></pre> <p>With the plugin installed, you can now capture OpenSearch queries:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>And you can send client-side events to OpenSearch:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>To see these events, check the <code>ubi_queries</code> and <code>ubi_events</code> indexes:</p> <pre><code>curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n</code></pre>"}]}
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"User Behavior Insights","text":""},{"location":"#welcome-to-user-behavior-insights-ubi","title":"Welcome to User Behavior Insights (UBI)!","text":"<p>UBI is a data standard along with a collection of tools and search engine plugins created to help search engineers gain and utilize an improved understanding of users' actions.</p>"},{"location":"#purpose-and-goals","title":"Purpose and Goals","text":"<p>Many Search teams struggle with understanding \"Why is my user doing this\". They have great understanding of an incoming query and the documents returned, but no ability to connect that dot with an indicator of success, such as a click through event or add to cart event.</p> <p>There are A LOT of tools out there for tracking events, Google Analytics, Snowplow, etc, but each is a bit different, and each tends to lock you in. None of them think about the needs of Search teams specifically either.</p> <p>The User Behavior Insights standard attempts to provide a search focused standard that can operate across many platforms. There are implementations for</p>"},{"location":"#reference-implementation","title":"Reference Implementation","text":"<p>A full reference implementation using OpenSearch is available at chorus-opensearch-edition.</p>"},{"location":"standard/","title":"User Behavior Insights Standard","text":"<p>The most important part of UBI is its standard that defines how queries and user events are defined.</p> <p>UBI requires coordination between the client (a browser, a mobile app, etc) and the backend, which is documented using JSON Schema.</p> <p>Learn more about the UBI Standard.</p>"},{"location":"tools/","title":"Tools and Plugins","text":"<p>There are several available tools and plugins supporting UBI.</p> <ul> <li>OpenSearch UBI plugin</li> <li>Elasticsearch UBI Plugin</li> <li>Apache Solr implementation</li> </ul>"},{"location":"tools/#ubi-plugin-for-opensearch","title":"UBI Plugin for OpenSearch","text":"<p>The OpenSearch UBI plugin facilitates persisting client-side events (e.g. item clicks, scroll depth) and OpenSearch queries for the purpose of analyzing the data to improve search relevance and user experience. The concepts of UBI and this plugin project was originally proposed in the OpenSearch UBI RFC.</p> <p>To use the plugin, first download the release appropriate for your version of OpenSearch. Next, install the plugin:</p> <pre><code>bin/opensearch-plugin install file:/opensearch-ubi-1.0.0-os2.14.0.zip\n</code></pre> <p>With the plugin installed, you can now capture OpenSearch queries:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>And you can send client-side events to OpenSearch:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>To see these events, check the <code>ubi_queries</code> and <code>ubi_events</code> indexes:</p> <pre><code>curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n</code></pre>"},{"location":"tools/#ubi-plugin-for-elasticsearch","title":"UBI Plugin for Elasticsearch","text":"<p>The Elasticsearch UBI Plugin is a fork of the OpenSearch UBI plugin. This plugin provides similar core functionality but other functionality will differ.</p> <p>To use the plugin, first download the release appropriate for your version of Elasticsearch. Next, install the plugin:</p> <pre><code>bin/elasticsearch-plugin install file:/elasticsearch-ubi-1.0.0-es2.14.0.zip\n</code></pre> <p>With the plugin installed, you can now capture OpenSearch queries:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>And you can send client-side events to OpenSearch:</p> <pre><code>curl -s http://localhost:9200/ecommerce/_search -H \"Content-Type: application/json\" -d'\n {\n  \"ext\": {\n   \"ubi\": {\n    }\n   },\n   \"query\": {\n     \"match\": {\n       \"name\": \"toner\"\n     }\n   }\n }'\n</code></pre> <p>To see these events, check the <code>ubi_queries</code> and <code>ubi_events</code> indexes:</p> <pre><code>curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n</code></pre>"}]}

standard/index.html

@@ -326,9 +326,8 @@
 
 <h1 id="user-behavior-insights-standard">User Behavior Insights Standard</h1>
 <p>The most important part of UBI is its standard that defines how queries and user events are defined.</p>
-<ul>
-<li><a href="https://www.github.com/o19s/ubi">UBI Standard</a></li>
-</ul>
+<p>UBI requires coordination between the client (a browser, a mobile app, etc) and the backend, which is documented using JSON Schema.</p>
+<p>Learn more about the <a href="https://www.github.com/o19s/ubi">UBI Standard</a>.</p>
 
 
 

tools/index.html

@@ -401,6 +401,7 @@ <h1 id="tools-and-plugins">Tools and Plugins</h1>
 <ul>
 <li><a href="https://www.github.com/opensearch-project/user-behavior-insights">OpenSearch UBI plugin</a></li>
 <li><a href="https://github.com/o19s/user-behavior-insights-elasticsearch">Elasticsearch UBI Plugin</a></li>
+<li><a href="https://github.com/apache/solr/pull/2452">Apache Solr implementation</a></li>
 </ul>
 <h2 id="ubi-plugin-for-opensearch">UBI Plugin for OpenSearch</h2>
 <p>The <a href="https://www.github.com/opensearch-project/user-behavior-insights">OpenSearch UBI plugin</a> facilitates persisting client-side events (e.g. item clicks, scroll depth) and OpenSearch queries for the purpose of analyzing the data to improve search relevance and user experience. The concepts of UBI and this plugin project was originally proposed in the <a href="https://github.com/opensearch-project/OpenSearch/issues/12084">OpenSearch UBI RFC</a>.</p>