Deployed 7772e2f with MkDocs version: 1.6.1

o19s · Nov 9, 2024 · 7ee8b3d · 7ee8b3d
1 parent b9b0960
commit 7ee8b3d
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 4 deletions.
diff --git a/search/search_index.json b/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>"},{"location":"tools/#ubi-plugin-for-opensearch","title":"UBI Plugin for OpenSearch","text":"<ul> <li>OpenSearch UBI Plugin</li> </ul>"},{"location":"tools/#ubi-plugin-for-elasticsearch","title":"UBI Plugin for Elasticsearch","text":"<ul> <li>OpenSearch UBI Plugin</li> </ul>"}]}
+{"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>"},{"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":"<ul> <li>OpenSearch UBI Plugin</li> </ul>"}]}
diff --git a/tools/index.html b/tools/index.html
@@ -399,9 +399,42 @@
 <h1 id="tools-and-plugins">Tools and Plugins</h1>
 <p>There are several available tools and plugins supporting UBI.</p>
 <h2 id="ubi-plugin-for-opensearch">UBI Plugin for OpenSearch</h2>
-<ul>
-<li><a href="https://www.github.com/opensearch-project/user-behavior-insights">OpenSearch UBI Plugin</a></li>
-</ul>
+<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>
+<p>To use the plugin, first <a href="https://github.com/o19s/opensearch-ubi/releases">download</a> 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
+</code></pre>
+<p>With the plugin installed, you can now capture OpenSearch queries:</p>
+<pre><code>curl -s http://localhost:9200/ecommerce/_search -H &quot;Content-Type: application/json&quot; -d'
+ {
+  &quot;ext&quot;: {
+   &quot;ubi&quot;: {
+    }
+   },
+   &quot;query&quot;: {
+     &quot;match&quot;: {
+       &quot;name&quot;: &quot;toner&quot;
+     }
+   }
+ }'
+</code></pre>
+<p>And you can send client-side events to OpenSearch:</p>
+<pre><code>curl -s http://localhost:9200/ecommerce/_search -H &quot;Content-Type: application/json&quot; -d'
+ {
+  &quot;ext&quot;: {
+   &quot;ubi&quot;: {
+    }
+   },
+   &quot;query&quot;: {
+     &quot;match&quot;: {
+       &quot;name&quot;: &quot;toner&quot;
+     }
+   }
+ }'
+</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
+curl http://localhost:9200/ubi_events/_search
+</code></pre>
 <h2 id="ubi-plugin-for-elasticsearch">UBI Plugin for Elasticsearch</h2>
 <ul>
 <li><a href="https://github.com/o19s/user-behavior-insights-elasticsearch">OpenSearch UBI Plugin</a></li>
Original file line number	Diff line number	Diff line change
		@@ -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>"},{"location":"tools/#ubi-plugin-for-opensearch","title":"UBI Plugin for OpenSearch","text":"<ul> <li>OpenSearch UBI Plugin</li> </ul>"},{"location":"tools/#ubi-plugin-for-elasticsearch","title":"UBI Plugin for Elasticsearch","text":"<ul> <li>OpenSearch UBI Plugin</li> </ul>"}]}
		{"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>"},{"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":"<ul> <li>OpenSearch UBI Plugin</li> </ul>"}]}