diff --git a/search/search_index.json b/search/search_index.json index 780587e..c769da9 100644 --- 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":"

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.

"},{"location":"#reference-implementation","title":"Reference Implementation","text":"

A full reference implementation using OpenSearch is available at chorus-opensearch-edition.

"},{"location":"standard/","title":"User Behavior Insights Standard","text":"

The most important part of UBI is its standard that defines how queries and user events are defined.

"},{"location":"tools/","title":"Tools and Plugins","text":"

There are several available tools and plugins supporting UBI.

"},{"location":"tools/#ubi-plugin-for-opensearch","title":"UBI Plugin for OpenSearch","text":"

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.

To use the plugin, first download the release appropriate for your version of OpenSearch. Next, install the plugin:

bin/opensearch-plugin install file:/opensearch-ubi-1.0.0-os2.14.0.zip\n

With the plugin installed, you can now capture OpenSearch queries:

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

And you can send client-side events to OpenSearch:

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

To see these events, check the ubi_queries and ubi_events indexes:

curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n
"},{"location":"tools/#ubi-plugin-for-elasticsearch","title":"UBI Plugin for Elasticsearch","text":""}]} \ No newline at end of file +{"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":"

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.

"},{"location":"#reference-implementation","title":"Reference Implementation","text":"

A full reference implementation using OpenSearch is available at chorus-opensearch-edition.

"},{"location":"standard/","title":"User Behavior Insights Standard","text":"

The most important part of UBI is its standard that defines how queries and user events are defined.

"},{"location":"tools/","title":"Tools and Plugins","text":"

There are several available tools and plugins supporting UBI.

"},{"location":"tools/#ubi-plugin-for-opensearch","title":"UBI Plugin for OpenSearch","text":"

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.

To use the plugin, first download the release appropriate for your version of OpenSearch. Next, install the plugin:

bin/opensearch-plugin install file:/opensearch-ubi-1.0.0-os2.14.0.zip\n

With the plugin installed, you can now capture OpenSearch queries:

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

And you can send client-side events to OpenSearch:

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

To see these events, check the ubi_queries and ubi_events indexes:

curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n
"},{"location":"tools/#ubi-plugin-for-elasticsearch","title":"UBI Plugin for Elasticsearch","text":"

The Elasticsearch UBI Plugin is a fork of the OpenSearch UBI plugin. This plugin provides similar core functionality but other functionality will differ.

To use the plugin, first download the release appropriate for your version of Elasticsearch. Next, install the plugin:

bin/elasticsearch-plugin install file:/elasticsearch-ubi-1.0.0-es2.14.0.zip\n

With the plugin installed, you can now capture OpenSearch queries:

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

And you can send client-side events to OpenSearch:

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

To see these events, check the ubi_queries and ubi_events indexes:

curl http://localhost:9200/ubi_queries/_search\ncurl http://localhost:9200/ubi_events/_search\n
"}]} \ No newline at end of file diff --git a/tools/index.html b/tools/index.html index e38c25a..f15477b 100644 --- a/tools/index.html +++ b/tools/index.html @@ -398,9 +398,13 @@

Tools and Plugins

There are several available tools and plugins supporting UBI.

+

UBI Plugin for OpenSearch

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.

-

To use the plugin, first download the release appropriate for your version of OpenSearch. Next, install the plugin:

+

To use the plugin, first download the release appropriate for your version of OpenSearch. Next, install the plugin:

bin/opensearch-plugin install file:/opensearch-ubi-1.0.0-os2.14.0.zip

With the plugin installed, you can now capture OpenSearch queries:

@@ -436,9 +440,42 @@

UBI Plugin for OpenSearch

curl http://localhost:9200/ubi_events/_search

UBI Plugin for Elasticsearch

- +

The Elasticsearch UBI Plugin is a fork of the OpenSearch UBI plugin. This plugin provides similar core functionality but other functionality will differ.

+

To use the plugin, first download the release appropriate for your version of Elasticsearch. Next, install the plugin:

+
bin/elasticsearch-plugin install file:/elasticsearch-ubi-1.0.0-es2.14.0.zip
+
+

With the plugin installed, you can now capture OpenSearch queries:

+
curl -s http://localhost:9200/ecommerce/_search -H "Content-Type: application/json" -d'
+ {
+  "ext": {
+   "ubi": {
+    }
+   },
+   "query": {
+     "match": {
+       "name": "toner"
+     }
+   }
+ }'
+
+

And you can send client-side events to OpenSearch:

+
curl -s http://localhost:9200/ecommerce/_search -H "Content-Type: application/json" -d'
+ {
+  "ext": {
+   "ubi": {
+    }
+   },
+   "query": {
+     "match": {
+       "name": "toner"
+     }
+   }
+ }'
+
+

To see these events, check the ubi_queries and ubi_events indexes:

+
curl http://localhost:9200/ubi_queries/_search
+curl http://localhost:9200/ubi_events/_search
+