User Behavior Insights - OpenSearch Documentation
User Behavior Insights | OpenSearch Documentation
OpenSearch
About
Releases
Roadmap
FAQ
Platform
Observability
Security Analytics
Vector Database
Playground Demo
Performance Benchmarks
Community
Forum
Slack
Events
Solutions Providers
Projects
Members
Documentation
OpenSearch and Dashboards
Data Prepper
Clients
Benchmark
Migration Assistant
Blog
Documentation
User Behavior Insights
Introduced 2.15
References UBI Specification 1.3.0
User Behavior Insights (UBI) is a schema for capturing user search behavior. Search behavior consists of the queries that the user submits, the results that are presented to them, and the actions they take on those results. The UBI schema links all user interactions (events) to the search result they were performed on. That is, it not only captures the chronological sequence of events but also captures the causal links between events. Analysis of this behavior is used for improving the quality of search results.
Client applications such as web pages or apps capture user behavior and send UBI data to a UBI endpoint. For web pages, this is typically handled by JavaScript code.
In principle, queries sent to the server and results returned by the server can be sent to the UBI endpoint from the client. But as an optimization, they can instead be sent directly to the UBI endpoint from the server, without incurring a round-trip to the client. That is the function of the UBI plugin and is not a requirement to adopt UBI.
“how our users are using our product, whether search results were useful for them and whether they clicked on top-n results we gave and all related stuff” – Data scientist working on search.
UBI includes the following elements:
A machine-readable
schema
that facilitates interoperability of the UBI specification.
ubi.js
: An (optional) client-side JavaScript library for capturing searches and events.
An (optional) OpenSearch
plugin
that streamlines the recording of query data.
Advanced features in OpenSearch, such as the
Search Relevance Workbench
and the
Hybrid Search Optimizer
, build on the data collected according to the UBI specification.
Tutorials
Learn to use Amazon OpenSearch Ingestion
pipelines for gathering UBI-formatted data in Amazon OpenSearch Service.
Learn to create custom dashboards
for visualizing UBI data.
Based on
Chorus for OpenSearch
demo:
Derive Interaction Data from User Clicks.
Protecting sensistive information when using UBI.
Configuring an AB test with Team Draft Interleaving
How To Guides
How to
install and use the UBI plugin
in OpenSearch.
How to use
ubi.js
, a client-side JavaScript library for capturing events.
How to
write queries for UBI data using OpenSearch query DSL.
How to
write analytic queries for UBI data using SQL.
Explanation
Why UBI?
presentation.
Learn more about this standard via
, the community clearinghouse.
Watch
Leveraging UBI to enhance Search Relevance
talk to understand how to use this data to improve search quality.
Go deeper with UBI. Watch
You’ve Deployed User Behavior Insights. Now What?
to see what else you can do.
Reference
UBI Plugin for OpenSearch
UBI Schema in OpenSearch
Repository for the
UBI Schema
Query Tracking Specification
Event Tracking Specification
The documentation categories were adapted using concepts based on
Diátaxis
Related documentation
UBI index schemas
UBI JavaScript Collector
Example UBI query DSL queries
Sample UBI SQL queries
UBI dashboard tutorial
Collecting UBI-formatted data in Amazon OpenSearch Service
Tutorials
How To Guides
Explanation
Reference
WAS THIS PAGE HELPFUL?
✔ Yes
✖ No
Tell us why
350 characters left
Thank you for your feedback!
Have a question?
Ask us on the OpenSearch forum
Want to contribute?
Edit this page
or
create an issue
OpenSearch Links
Get Involved
Code of Conduct
Forum
GitHub
Slack
Resources
About
Release Schedule
Maintenance Policy
FAQ
Testimonials
Trademark and Brand Policy
Connect
Meetup
Copyright © OpenSearch Project a Series of LF Projects, LLC
For web site terms of use, trademark policy and other project policies please see
US