You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _search-plugins/ubi/index.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,33 +22,33 @@ This differs from many systems that infer the linking of search to events throug
22
22
> “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
23
23
24
24
UBI includes the following elements:
25
-
*[ubi.js](https://github.com/opensearch-project/user-behavior-insights/tree/main/ubi-javascript-collector/ubi.js): a clientside JavaScript library for capturing searches and events.
25
+
*[ubi.js](https://github.com/opensearch-project/user-behavior-insights/tree/main/ubi-javascript-collector/ubi.js): a (optional!) clientside JavaScript library for capturing searches and events.
26
26
* A machine-readable [schema](https://github.com/o19s/ubi) that faciliates interoperability of the UBI specification.
27
27
* An (optional!) OpenSearch [plugin](https://github.com/opensearch-project/user-behavior-insights) that streamlines the recording of query data.
28
28
29
-
Advanced features in OpenSearch, such as the Search Quality Evaluation Framework, and the Hybrid Search Optimizer all build on the UBI specification.
29
+
Advanced features in OpenSearch, such as the [Search Relevance Workbench]({{site.url}}{{site.baseurl}}/search-plugins/search-relevance/using-search-relevance-workbench/)and the [Hybrid Search Optimizer]({{site.url}}{{site.baseurl}}/search-plugins/search-relevance/optimize-hybrid-search/)build on the data collected using the UBI specification.
30
30
31
31
<!-- vale off -->
32
32
33
33
<table>
34
34
<tr style="vertical-align: top;">
35
35
<td>
36
36
<h2>Tutorials</h2>
37
-
<ul>
38
-
<li><a href="#">Learn to use <code>ubi.js</code></a></li>
39
-
<li><a href="https://github.com/opensearch-project/user-behavior-insights">How to install and use the UBI plugin</a><b>do we keep this</b></li>
37
+
<ul>
40
38
<li><a href="#">Using OpenSearch Ingestion from AWS with UBI</a></li>
41
-
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-dashboard-tutorial/">Learn to create custom dashboards with UBI data.</a></li>
39
+
<li><a href="#">Learn to use <code>ubi.js</code></a></li>
40
+
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-dashboard-tutorial/">Learn to create custom dashboards</a> for UBI data.</li>
42
41
</ul>
43
42
</td>
44
43
<td>
45
44
<h2>How To Guides</h2>
46
45
<ul>
46
+
<li><a href="https://github.com/opensearch-project/user-behavior-insights">How to use the UBI plugin</a> in OpenSearch</li>.
47
47
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/dsl-queries/">How to write queries for UBI data in OpenSearch query DSL.</a></li>
48
48
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/sql-queries/">How to write analytic queries for UBI data in SQL.</a></li>
49
49
<li><a href="https://github.com/o19s/chorus-opensearch-edition/blob/main/katas/006_protecting_sensitive_information.md">How to protect sensistive information when using UBI.</a></li>
50
50
<li><a href="https://github.com/o19s/chorus-opensearch-edition/blob/main/katas/007_configure_AB_with_TDI.md">Configuring an AB test with Team Draft Interleaving</a></li>
51
-
<li><a href="https://github.com/opensearch-project/user-behavior-insights">How to install and use the UBI plugin</a><b>do we keep this</b></li>
51
+
<li><a href="https://github.com/opensearch-project/user-behavior-insights">How to install and use the UBI plugin</a><b>do we keep this</b></li>
52
52
</ul>
53
53
</td>
54
54
</tr>
@@ -58,16 +58,18 @@ Advanced features in OpenSearch, such as the Search Quality Evaluation Framework
Copy file name to clipboardExpand all lines: _search-plugins/ubi/sql-queries.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,16 +10,16 @@ nav_order: 20
10
10
11
11
You can run sample User Behavior Insights (UBI) SQL queries in the OpenSearch Dashboards [Query Workbench]({{site.url}}{{site.baseurl}}/dashboards/query-workbench/).
12
12
13
-
To query a demo workbench with synthetic data, see
13
+
To access a demo query workbench with synthetic data, see
Queries can be executed on events on either the server (`ubi_queries`) or client (`ubi_events`) side.
18
+
Queries can be executed on events on either the queries index (`ubi_queries`) or events index (`ubi_events`).
19
19
20
20
### Server-side queries
21
21
22
-
The UBI-activated search server logs the queries and their results, so in order to find all queries with *no* results, search for empty `query_response_hit_ids`:
22
+
A UBI-enabled search server logs the queries and their results as they are made, so in order to find all queries with *no* results, search for empty `query_response_hit_ids`:
Copy file name to clipboardExpand all lines: _search-plugins/ubi/ubi-dashboard-tutorial.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ nav_order: 25
11
11
12
12
Whether you've been collecting user events and queries for a while or [you've uploaded some sample events](https://github.com/o19s/chorus-OpenSearch-edition/blob/main/katas/003_import_preexisting_event_data.md), you're now ready to visualize the data collected through User Behavior Insights (UBI) in a dashboard in OpenSearch.
13
13
14
+
> This tutorial is a nice way to learn how to make custom Dashboards.
15
+
14
16
To quickly view a dashboard without completing the full tutorial, do the following:
15
17
1. Download and save the [sample UBI dashboard]({{site.url}}{{site.baseurl}}/assets/examples/ubi-dashboard.ndjson).
16
18
1. On the top menu, go to **Management > Dashboard Management**.
@@ -90,5 +92,3 @@ Now you can further filter the displayed data. For example, you can see how the
90
92
91
93
You can filter event messages containing the word `*laptop*` by adding wildcards, as shown in the following image.
0 commit comments