Skip to content

Commit 790875b

Browse files
committed
lots of clean ups
1 parent ce35481 commit 790875b

File tree

3 files changed

+18
-16
lines changed

3 files changed

+18
-16
lines changed

_search-plugins/ubi/index.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,33 +22,33 @@ This differs from many systems that infer the linking of search to events throug
2222
> “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
2323
2424
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.
2626
* A machine-readable [schema](https://github.com/o19s/ubi) that faciliates interoperability of the UBI specification.
2727
* An (optional!) OpenSearch [plugin](https://github.com/opensearch-project/user-behavior-insights) that streamlines the recording of query data.
2828

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.
3030

3131
<!-- vale off -->
3232

3333
<table>
3434
<tr style="vertical-align: top;">
3535
<td>
3636
<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>
4038
<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>
4241
</ul>
4342
</td>
4443
<td>
4544
<h2>How To Guides</h2>
4645
<ul>
46+
<li><a href="https://github.com/opensearch-project/user-behavior-insights">How to use the UBI plugin</a> in OpenSearch</li>.
4747
<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>
4848
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/sql-queries/">How to write analytic queries for UBI data in SQL.</a></li>
4949
<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>
5050
<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>
5252
</ul>
5353
</td>
5454
</tr>
@@ -58,16 +58,18 @@ Advanced features in OpenSearch, such as the Search Quality Evaluation Framework
5858
<ul>
5959
<li><a href="https://UBISearch.dev">Why UBI?</a></li>
6060
<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>
61-
<li>Learn more about this community standard via <a href="https://UBISearch.dev">UBISearch.dev</a>.</li>
61+
<li>Learn more about this community standard via <a href="https://UBISearch.dev">UBISearch.dev</a> community clearinghouse.</li>
6262
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-javascript-collector/">UBI JavaScript Collector</a>, a client-side JavaScript library for capturing events.</li>
63+
<li>Learn more about improving relevance. Watch <a href="https://youtu.be/0chun264PRQ">Leveraging UBI to enhance Search Relevance</a> talk.</li>
64+
<li>Learn how to build on UBI data. Watch <a href="https://www.youtube.com/watch?v=xi261oUamXc">You’ve Deployed User Behavior Insights. Now What?</a>.
6365
</ul>
6466
</td>
6567
<td>
6668
<h2>Reference</h2>
6769
<ul>
68-
<li><a href="https://o19s.github.io/ubi/docs/html/1.2.0/query.request.schema.html">Query Tracking Specification</a></li>
69-
<li><a href="https://o19s.github.io/ubi/docs/html/1.2.0/event.schema.html">Event Tracking Specification</a></li>
70-
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/schemas/">UBI Plugin Schema</a><b>DO WE KEEP THIS</b></li>
70+
<li><a href="https://o19s.github.io/ubi/docs/html/1.3.0/query.request.schema.html">Query Tracking Specification</a></li>
71+
<li><a href="https://o19s.github.io/ubi/docs/html/1.3.0/event.schema.html">Event Tracking Specification</a></li>
72+
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/schemas/">UBI Plugin Schema</a></li>
7173
</ul>
7274
</td>
7375
</tr>

_search-plugins/ubi/sql-queries.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ nav_order: 20
1010

1111
You can run sample User Behavior Insights (UBI) SQL queries in the OpenSearch Dashboards [Query Workbench]({{site.url}}{{site.baseurl}}/dashboards/query-workbench/).
1212

13-
To query a demo workbench with synthetic data, see
13+
To access a demo query workbench with synthetic data, see
1414
[http://chorus-opensearch-edition.dev.o19s.com:5601/app/opensearch-query-workbench](http://chorus-opensearch-edition.dev.o19s.com:5601/app/opensearch-query-workbench).
1515

1616
## Queries with zero results
1717

18-
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`).
1919

2020
### Server-side queries
2121

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`:
2323

2424
```sql
2525
select

_search-plugins/ubi/ubi-dashboard-tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ nav_order: 25
1111

1212
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.
1313

14+
> This tutorial is a nice way to learn how to make custom Dashboards.
15+
1416
To quickly view a dashboard without completing the full tutorial, do the following:
1517
1. Download and save the [sample UBI dashboard]({{site.url}}{{site.baseurl}}/assets/examples/ubi-dashboard.ndjson).
1618
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
9092

9193
You can filter event messages containing the word `*laptop*` by adding wildcards, as shown in the following image.
9294
![Laptop]({{site.url}}{{site.baseurl}}/images/ubi/laptop.png "Laptop").
93-
94-

0 commit comments

Comments
 (0)