diff --git a/search/search_index.json b/search/search_index.json index 2ea66b7..2cf4469 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","title":"Welcome to User Behavior Insights!","text":"

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.

"},{"location":"#ubi-in-action","title":"UBI in Action!","text":""},{"location":"#help-getting-started","title":"Help Getting Started","text":"

For questions or help getting started, reach out to help@ubisearch.dev or join us in the #ubi channel of the Relevance Slack workspace and we will be glad to help!

"},{"location":"#purpose-and-goals","title":"Purpose and Goals","text":"

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.

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.

The User Behavior Insights standard attempts to provide a search focused standard that can operate across many platforms. There are implementations for

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

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.

"},{"location":"#sponsored-by","title":"Sponsored By","text":"Person Affiliation Contact Eric Pugh OpenSource Connections epugh@opensourceconnections.com Jeff Zemerick Mountain Fog jeff.zemerick@mtnfog.com Stavros Macrakis Amazon Charlie Hull thesearchjuggler@gmail.com"},{"location":"#what-ubi-powers","title":"What UBI Powers","text":"

Are you or your organization using UBI? Let us know! We'd love to hear about it and tell your success story here.

"},{"location":"datasets/","title":"Datasets","text":"

This page lists datasets and data generation utilities for use with UBI.

When working to integrate with UBI it can be helpful to have data in the UBI format to design and develop against.

Refer to the Samples for JSON files illustrating events and queries in the UBI format.

"},{"location":"datasets/#ubi-data-generator","title":"UBI Data Generator","text":"

The UBI Data Generator generates UBI data from the Amazon ESCI dataset. The generated UBI data can be exported as CSV and imported into a search engine index.

"},{"location":"datasets/#ubi-chorus-data-generator","title":"UBI Chorus Data Generator","text":"

The UBI Chorus Data Generator creates fake, random UBI data and indexes it into OpenSearch. The randomly generated data is useful for development and debugging of UBI tools and plugins.

"},{"location":"get_involved/","title":"Get Involved","text":"

Everything about UBI is open source! The standard, plugins, tools, and data sets are all open source.

We welcome your contributions no matter how small they may be!

To contribute, you can look at the GitHub Issues in each of the following repositories. You can also reach out for help getting started.

"},{"location":"get_involved/#ubi-repositories","title":"UBI Repositories","text":""},{"location":"help/","title":"Help","text":"

For questions or help getting started, reach out to help@ubisearch.dev and we will be glad to help!

You can also get in touch in the #ubi channel of the Relevance Slack workspace.

"},{"location":"news/","title":"UBI News","text":""},{"location":"news/#ubi-120-announced-october-25-2024","title":"UBI 1.2.0 Announced - October 25, 2024","text":"

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.

Learn more about the changes in version 1.2 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.2.0.

"},{"location":"news/#initial-ubi-plugin-for-elasticsearch-october-9-2024","title":"Initial UBI Plugin for Elasticsearch - October 9, 2024","text":"

The initial code for a UBI plugin for Elasticsearch is now available.

"},{"location":"news/#opensearch-2171-ubi-plugin-october-4-2024","title":"OpenSearch 2.17.1 UBI Plugin - October 4, 2024","text":"

The UBI plugin for OpenSearch 2.17.1 is now available.

See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.17.1.0.

"},{"location":"news/#ubi-110-announced-august-31-2024","title":"UBI 1.1.0 Announced - August 31, 2024","text":"

First release with third party users looking to leverage UBI. This release is primarily adding things we initially decided to skip, and being more relaxed in our requirements for validation.

Learn more about the changes in version 1.1.0 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.1.0.

"},{"location":"news/#opensearch-2160-ubi-plugin-august-20-2024","title":"OpenSearch 2.16.0 UBI Plugin - August 20, 2024","text":"

The UBI plugin for OpenSearch 2.16.0 is now available.

See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.16.0.0.

"},{"location":"news/#opensearch-2150-ubi-plugin-june-27-2024","title":"OpenSearch 2.15.0 UBI Plugin - June 27, 2024","text":"

The UBI plugin for OpenSearch 2.15.0 is now available.

See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.15.0.0.

"},{"location":"news/#ubi-100-announced-june-14-2024","title":"UBI 1.0.0 Announced - June 14, 2024","text":"

This is the first release of the User Behavior Insights specification that supports tracking of user queries and subsequent actions. Using this schema allows you to validate that your query data and event data are UBI compliant.

Learn more about the changes in version 1.0.0 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.0.0.

"},{"location":"quickstart/","title":"Quick Start","text":"

The Chorus project provides a UBI reference implementation that you can use to build on or model your search stack. Chorus uses OpenSearch, but the instructions generally apply also to Elasticsearch.

First, clone the Chorus repository.

git clone https://github.com/o19s/chorus-opensearch-edition.git\n

Next, the quickstart script will launch OpenSearch, download and index the sample product data for the ecommerce index:

./quickstart.sh\n

TODO: Insert some steps here.

When finished, you can clean up the Docker resources:

docker compose down -v\n
"},{"location":"standard/","title":"The User Behavior Insights (UBI) Standard","text":"

See the latest version of the UBI Standard!

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

UBI requires coordination between the client (a browser, a mobile app, etc) and the backend, which is documented using JSON Schema.

The Schema is documented by itself, but it's much easier to get \"the big picture\" with a graphical representation:

The UBI standard is available under the Apache Software License, version 2.

"},{"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 +{"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":"

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.

"},{"location":"#ubi-in-action","title":"UBI in Action!","text":""},{"location":"#help-getting-started","title":"Help Getting Started","text":"

For questions or help getting started, reach out to help@ubisearch.dev or join us in the #ubi channel of the Relevance Slack workspace and we will be glad to help!

"},{"location":"#purpose-and-goals","title":"Purpose and Goals","text":"

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.

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.

The User Behavior Insights standard attempts to provide a search focused standard that can operate across many platforms. There are implementations for

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

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.

"},{"location":"#sponsored-by","title":"Sponsored By","text":"Person Affiliation Contact Eric Pugh OpenSource Connections epugh@opensourceconnections.com Jeff Zemerick Mountain Fog jeff.zemerick@mtnfog.com Stavros Macrakis Amazon Charlie Hull thesearchjuggler@gmail.com"},{"location":"#what-ubi-powers","title":"What UBI Powers","text":"

Are you or your organization using UBI? Let us know! We'd love to hear about it and tell your success story here.

"},{"location":"datasets/","title":"Datasets","text":"

This page lists datasets and data generation utilities for use with UBI.

When working to integrate with UBI it can be helpful to have data in the UBI format to design and develop against.

Refer to the Samples for JSON files illustrating events and queries in the UBI format.

"},{"location":"datasets/#ubi-data-generator","title":"UBI Data Generator","text":"

The UBI Data Generator generates UBI data from the Amazon ESCI dataset. The generated UBI data can be exported as CSV and imported into a search engine index.

"},{"location":"datasets/#ubi-chorus-data-generator","title":"UBI Chorus Data Generator","text":"

The UBI Chorus Data Generator creates fake, random UBI data and indexes it into OpenSearch. The randomly generated data is useful for development and debugging of UBI tools and plugins.

"},{"location":"get_involved/","title":"Get Involved","text":"

Everything about UBI is open source! The standard, plugins, tools, and data sets are all open source.

We welcome your contributions no matter how small they may be!

To contribute, you can look at the GitHub Issues in each of the following repositories. You can also reach out for help getting started.

"},{"location":"get_involved/#ubi-repositories","title":"UBI Repositories","text":""},{"location":"help/","title":"Help","text":"

For questions or help getting started, reach out to help@ubisearch.dev and we will be glad to help!

You can also get in touch in the #ubi channel of the Relevance Slack workspace.

"},{"location":"news/","title":"UBI News","text":""},{"location":"news/#ubi-120-announced-october-25-2024","title":"UBI 1.2.0 Announced - October 25, 2024","text":"

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.

Learn more about the changes in version 1.2 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.2.0.

"},{"location":"news/#initial-ubi-plugin-for-elasticsearch-october-9-2024","title":"Initial UBI Plugin for Elasticsearch - October 9, 2024","text":"

The initial code for a UBI plugin for Elasticsearch is now available.

"},{"location":"news/#opensearch-2171-ubi-plugin-october-4-2024","title":"OpenSearch 2.17.1 UBI Plugin - October 4, 2024","text":"

The UBI plugin for OpenSearch 2.17.1 is now available.

See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.17.1.0.

"},{"location":"news/#ubi-110-announced-august-31-2024","title":"UBI 1.1.0 Announced - August 31, 2024","text":"

First release with third party users looking to leverage UBI. This release is primarily adding things we initially decided to skip, and being more relaxed in our requirements for validation.

Learn more about the changes in version 1.1.0 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.1.0.

"},{"location":"news/#opensearch-2160-ubi-plugin-august-20-2024","title":"OpenSearch 2.16.0 UBI Plugin - August 20, 2024","text":"

The UBI plugin for OpenSearch 2.16.0 is now available.

See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.16.0.0.

"},{"location":"news/#opensearch-2150-ubi-plugin-june-27-2024","title":"OpenSearch 2.15.0 UBI Plugin - June 27, 2024","text":"

The UBI plugin for OpenSearch 2.15.0 is now available.

See what's new and download it at https://github.com/opensearch-project/user-behavior-insights/releases/tag/2.15.0.0.

"},{"location":"news/#ubi-100-announced-june-14-2024","title":"UBI 1.0.0 Announced - June 14, 2024","text":"

This is the first release of the User Behavior Insights specification that supports tracking of user queries and subsequent actions. Using this schema allows you to validate that your query data and event data are UBI compliant.

Learn more about the changes in version 1.0.0 of the UBI standard at https://github.com/o19s/ubi/releases/tag/v1.0.0.

"},{"location":"quickstart/","title":"Quick Start","text":"

The Chorus project provides a UBI reference implementation that you can use to build on or model your search stack. Chorus uses OpenSearch, but the instructions generally apply also to Elasticsearch.

First, clone the Chorus repository.

git clone https://github.com/o19s/chorus-opensearch-edition.git\n

Next, the quickstart script will launch OpenSearch, download and index the sample product data for the ecommerce index:

./quickstart.sh\n

TODO: Insert some steps here.

When finished, you can clean up the Docker resources:

docker compose down -v\n
"},{"location":"standard/","title":"The User Behavior Insights (UBI) Standard","text":"

See the latest version of the UBI specification!

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

UBI requires coordination between the client (a browser, a mobile app, etc) and the backend, which is documented using JSON Schema.

The schema is documented by itself, but it's much easier to get \"the big picture\" with a graphical representation:

The UBI standard is available under the Apache Software License, version 2.

"},{"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/standard/index.html b/standard/index.html index 7109505..0f16efd 100644 --- a/standard/index.html +++ b/standard/index.html @@ -425,10 +425,10 @@

The User Behavior Insights (UBI) Standard

-

See the latest version of the UBI Standard!

+

See the latest version of the UBI specification!

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

UBI requires coordination between the client (a browser, a mobile app, etc) and the backend, which is documented using JSON Schema.

-

The Schema is documented by itself, but it's much easier to get "the big picture" with a graphical representation:

+

The schema is documented by itself, but it's much easier to get "the big picture" with a graphical representation:

ubi

The UBI standard is available under the Apache Software License, version 2.