Deployed 2063efd with MkDocs version: 1.6.1

o19s · Nov 9, 2024 · ddf17c0 · ddf17c0
1 parent cb74880
commit ddf17c0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/index.html b/index.html
@@ -549,9 +549,9 @@ <h3 id="help-getting-started">Help Getting Started</h3>
 <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>
+<p>The User Behavior Insights <a href="standard/">standard</a> 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>
+<p>A full reference implementation using OpenSearch is available at <a href="https://github.com/o19s/chorus-opensearch-edition">chorus-opensearch-edition</a>. Check out the <a href="quickstart/">Quick Start</a> for details on getting up and running with an example environment.</p>
 <h2 id="sponsored-by">Sponsored By</h2>
 <table>
 <thead>

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","title":"Welcome to User Behavior Insights!","text":"<p>User Behavior Insights, or 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":"#help-getting-started","title":"Help Getting Started","text":"<p>For questions or help getting started, reach out to [email protected] or join us in the <code>#ubi</code> channel of the Relevance Slack workspace and we will be glad to help!</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":"#sponsored-by","title":"Sponsored By","text":"Person Affiliation Contact Eric Pugh OpenSource Connections [email protected] Jeff Zemerick Mountain Fog [email protected] Stavros Macrakis Amazon Charlie Hull"},{"location":"#what-ubi-powers","title":"What UBI Powers","text":"<p>Are you or your organization using UBI? Let us know! We'd love to hear about it and tell your success story here.</p>"},{"location":"help/","title":"Help","text":"<p>For questions or help getting started, reach out to [email protected] and we will be glad to help!</p> <p>You can also get in touch in the <code>#ubi</code> channel of the Relevance Slack workspace.</p>"},{"location":"news/","title":"UBI News","text":""},{"location":"news/#ubi-12-announced-october-25-2024","title":"UBI 1.2 Announced - October 25, 2024","text":"<p>This release introduces a formal application element to both queries and events so you can distingus different sources of queries and their follow on events. Think type-ahead and search as two common applications.  We also formalize that the timestamps are ISO 8601 formatted. </p> <p>Learn more about the changes in version 1.2 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.2.0.</p>"},{"location":"news/#opensearch-2171-ubi-plugin-october-4-2024","title":"OpenSearch 2.17.1 UBI Plugin - October 4, 2024","text":"<p>The UBI plugin for OpenSearch 2.17.1 is now available.</p> <p>See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.17.1.0.</p>"},{"location":"quickstart/","title":"Quick Start","text":""},{"location":"standard/","title":"The User Behavior Insights (UBI) 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>"}]}
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"User Behavior Insights","text":""},{"location":"#welcome-to-user-behavior-insights","title":"Welcome to User Behavior Insights!","text":"<p>User Behavior Insights, or 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":"#help-getting-started","title":"Help Getting Started","text":"<p>For questions or help getting started, reach out to [email protected] or join us in the <code>#ubi</code> channel of the Relevance Slack workspace and we will be glad to help!</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. Check out the Quick Start for details on getting up and running with an example environment.</p>"},{"location":"#sponsored-by","title":"Sponsored By","text":"Person Affiliation Contact Eric Pugh OpenSource Connections [email protected] Jeff Zemerick Mountain Fog [email protected] Stavros Macrakis Amazon Charlie Hull"},{"location":"#what-ubi-powers","title":"What UBI Powers","text":"<p>Are you or your organization using UBI? Let us know! We'd love to hear about it and tell your success story here.</p>"},{"location":"help/","title":"Help","text":"<p>For questions or help getting started, reach out to [email protected] and we will be glad to help!</p> <p>You can also get in touch in the <code>#ubi</code> channel of the Relevance Slack workspace.</p>"},{"location":"news/","title":"UBI News","text":""},{"location":"news/#ubi-12-announced-october-25-2024","title":"UBI 1.2 Announced - October 25, 2024","text":"<p>This release introduces a formal application element to both queries and events so you can distingus different sources of queries and their follow on events. Think type-ahead and search as two common applications.  We also formalize that the timestamps are ISO 8601 formatted. </p> <p>Learn more about the changes in version 1.2 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.2.0.</p>"},{"location":"news/#opensearch-2171-ubi-plugin-october-4-2024","title":"OpenSearch 2.17.1 UBI Plugin - October 4, 2024","text":"<p>The UBI plugin for OpenSearch 2.17.1 is now available.</p> <p>See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.17.1.0.</p>"},{"location":"quickstart/","title":"Quick Start","text":""},{"location":"standard/","title":"The User Behavior Insights (UBI) 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>"}]}
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","title":"Welcome to User Behavior Insights!","text":"<p>User Behavior Insights, or 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":"#help-getting-started","title":"Help Getting Started","text":"<p>For questions or help getting started, reach out to [email protected] or join us in the <code>#ubi</code> channel of the Relevance Slack workspace and we will be glad to help!</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":"#sponsored-by","title":"Sponsored By","text":"Person Affiliation Contact Eric Pugh OpenSource Connections [email protected] Jeff Zemerick Mountain Fog [email protected] Stavros Macrakis Amazon Charlie Hull"},{"location":"#what-ubi-powers","title":"What UBI Powers","text":"<p>Are you or your organization using UBI? Let us know! We'd love to hear about it and tell your success story here.</p>"},{"location":"help/","title":"Help","text":"<p>For questions or help getting started, reach out to [email protected] and we will be glad to help!</p> <p>You can also get in touch in the <code>#ubi</code> channel of the Relevance Slack workspace.</p>"},{"location":"news/","title":"UBI News","text":""},{"location":"news/#ubi-12-announced-october-25-2024","title":"UBI 1.2 Announced - October 25, 2024","text":"<p>This release introduces a formal application element to both queries and events so you can distingus different sources of queries and their follow on events. Think type-ahead and search as two common applications. We also formalize that the timestamps are ISO 8601 formatted. </p> <p>Learn more about the changes in version 1.2 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.2.0.</p>"},{"location":"news/#opensearch-2171-ubi-plugin-october-4-2024","title":"OpenSearch 2.17.1 UBI Plugin - October 4, 2024","text":"<p>The UBI plugin for OpenSearch 2.17.1 is now available.</p> <p>See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.17.1.0.</p>"},{"location":"quickstart/","title":"Quick Start","text":""},{"location":"standard/","title":"The User Behavior Insights (UBI) 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>"}]}
		{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"User Behavior Insights","text":""},{"location":"#welcome-to-user-behavior-insights","title":"Welcome to User Behavior Insights!","text":"<p>User Behavior Insights, or 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":"#help-getting-started","title":"Help Getting Started","text":"<p>For questions or help getting started, reach out to [email protected] or join us in the <code>#ubi</code> channel of the Relevance Slack workspace and we will be glad to help!</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. Check out the Quick Start for details on getting up and running with an example environment.</p>"},{"location":"#sponsored-by","title":"Sponsored By","text":"Person Affiliation Contact Eric Pugh OpenSource Connections [email protected] Jeff Zemerick Mountain Fog [email protected] Stavros Macrakis Amazon Charlie Hull"},{"location":"#what-ubi-powers","title":"What UBI Powers","text":"<p>Are you or your organization using UBI? Let us know! We'd love to hear about it and tell your success story here.</p>"},{"location":"help/","title":"Help","text":"<p>For questions or help getting started, reach out to [email protected] and we will be glad to help!</p> <p>You can also get in touch in the <code>#ubi</code> channel of the Relevance Slack workspace.</p>"},{"location":"news/","title":"UBI News","text":""},{"location":"news/#ubi-12-announced-october-25-2024","title":"UBI 1.2 Announced - October 25, 2024","text":"<p>This release introduces a formal application element to both queries and events so you can distingus different sources of queries and their follow on events. Think type-ahead and search as two common applications. We also formalize that the timestamps are ISO 8601 formatted. </p> <p>Learn more about the changes in version 1.2 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.2.0.</p>"},{"location":"news/#opensearch-2171-ubi-plugin-october-4-2024","title":"OpenSearch 2.17.1 UBI Plugin - October 4, 2024","text":"<p>The UBI plugin for OpenSearch 2.17.1 is now available.</p> <p>See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.17.1.0.</p>"},{"location":"quickstart/","title":"Quick Start","text":""},{"location":"standard/","title":"The User Behavior Insights (UBI) 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>"}]}