Skip to content

Commit c9f610c

Browse files
epughepugh
committed
Restructure content into clearer four types.
Signed-off-by: Eric Pugh <[email protected]>
1 parent eba662e commit c9f610c

File tree

1 file changed

+49
-24
lines changed

1 file changed

+49
-24
lines changed

‎_search-plugins/ubi/index.md

+49-24
Original file line numberDiff line numberDiff line change
@@ -14,38 +14,63 @@ redirect_from:
1414
**References UBI Specification 1.2.0**
1515
{: .label .label-purple }
1616

17-
User Behavior Insights (UBI) is a project for capturing client-side events and queries for the purposes of improving search relevance and the user experience.
17+
User Behavior Insights (UBI) is a standard for capturing client-side events and queries for the purposes of improving search relevance and the user experience.
1818
It is a *causal* system, linking a user's query to all of their subsequent interactions with your application until they perform another search.
1919
This differs from many systems that infer the linking of search to events through *chronological* sequence.
2020

21-
UBI includes the following elements:
22-
* A machine-readable [schema](https://github.com/o19s/ubi) that faciliates interoperablity of the UBI specification.
23-
* An OpenSearch [plugin](https://github.com/opensearch-project/user-behavior-insights) that facilitates the storage of client-side events and queries.
24-
* A client-side JavaScript [reference implementation](https://github.com/opensearch-project/user-behavior-insights/tree/main/ubi-javascript-collector/ubi.js) that shows how to capture searches and events.
25-
26-
<!-- vale off -->
2721

28-
The UBI documentation is organized into two categories: *Explanation and reference* and *Tutorials and how-to guides*:
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
2923
30-
*Explanation and reference*
31-
32-
| Link | Description |
33-
| :--------- | :------- |
34-
| [UBISearch.dev](https://UBISearch.dev) | The User Behavior Insights community website. |
35-
| [UBI Request/Response Specification](https://github.com/o19s/ubi/) | The industry-standard schema for UBI requests and responses. The current version references UBI Specification 1.2.0. |
36-
| [UBI index schema]({{site.url}}{{site.baseurl}}/search-plugins/ubi/schemas/) | Documentation on the individual OpenSearch query and event stores. |
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 client-side JavaScript library that captures searches and events.
26+
* A machine-readable [schema](https://github.com/o19s/ubi) that faciliates interoperablity of the UBI specification.
27+
* An (optional!) OpenSearch [plugin](https://github.com/opensearch-project/user-behavior-insights) that streamlines the recording of query data.
3728

29+
Advanced features in OpenSearch, such as the Search Quality Evaluation Framework, and the Hybrid Search Optimizer all build on the UBI specification.
3830

39-
*Tutorials and how-to guides*
31+
<!-- vale off -->
4032

41-
| Link | Description |
42-
| :--------- | :------- |
43-
| [UBI plugin](https://github.com/opensearch-project/user-behavior-insights) | How to install and use the UBI plugin. |
44-
| [UBI JavaScript Collector]({{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-javascript-collector/) | Clientside JavaScript library to capture events. |
45-
| [Example UBI query DSL queries]({{site.url}}{{site.baseurl}}/search-plugins/ubi/dsl-queries/) | How to write queries for UBI data in OpenSearch query DSL. |
46-
| [Example UBI SQL queries]({{site.url}}{{site.baseurl}}/search-plugins/ubi/sql-queries/) | How to write analytic queries for UBI data in SQL. |
47-
| [UBI dashboard tutorial]({{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-dashboard-tutorial/) | How to build a dashboard containing UBI data. |
48-
| [Chorus Opensearch Edition](https://github.com/o19s/chorus-opensearch-edition/?tab=readme-ov-file#structured-learning-using-chorus-opensearch-edition) katas | A series of structured tutorials that teach you how to use UBI with OpenSearch through a demo e-commerce store. |
33+
<table>
34+
<tr style="vertical-align: top;">
35+
<td>
36+
<h2>Tutorials</h2>
37+
<ul>
38+
<li><a href="#">Learn to use <code>ubi.js</code></a></li>
39+
<li><a href="#">Using OpenSearch Ingestion from AWS with UBI</a></li>
40+
<li><a href="#">Link 3</a></li>
41+
</ul>
42+
</td>
43+
<td>
44+
<h2>How To Guides</h2>
45+
<ul>
46+
<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>
47+
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-dashboard-tutorial/">How to build a custom dashboard with UBI data.</a></li>
48+
<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>
49+
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/sql-queries/">How to write analytic queries for UBI data in SQL.</a></li>
50+
<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> <small>Part of Chorus series.</small></li>
51+
</ul>
52+
</td>
53+
</tr>
54+
<tr style="vertical-align: top;">
55+
<td>
56+
<h2>Explanation</h2>
57+
<ul>
58+
<li><a href="https://UBISearch.dev">Why UBI?</a></li>
59+
<li><a href="">How should I integrate UBI tracking?</a></li>
60+
<li><a href="https://UBISearch.dev">UBISearch.dev</a> is the community website.</li>
61+
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/ubi-javascript-collector/">UBI.js</a> JavaScript collector</li>
62+
</ul>
63+
</td>
64+
<td>
65+
<h2>Reference</h2>
66+
<ul>
67+
<li><a href="https://o19s.github.io/ubi/docs/html/1.2.0/query.request.schema.html">Query Tracking Specification</a></li>
68+
<li><a href="https://o19s.github.io/ubi/docs/html/1.2.0/event.schema.html">Event Tracking Specification</a></li>
69+
<li><a href="{{site.url}}{{site.baseurl}}/search-plugins/ubi/schemas/">UBI Plugin Schema</a><b>DO WE KEEP THIS</b></li>
70+
</ul>
71+
</td>
72+
</tr>
73+
</table>
4974

5075
<!-- vale on -->
5176
The documentation categories were adapted using concepts based on [Diátaxis](https://diataxis.fr/).

0 commit comments

Comments
 (0)