Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add agent framework/throttling/hidden model/OS assistant and update conversational search documentation #6354

Merged
merged 41 commits into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
2102d08
Add agent framework documentation
kolchfa-aws Feb 5, 2024
b50da8c
Add hidden model and API updates
kolchfa-aws Feb 5, 2024
45963b0
Merge branch 'main' into agent-framework
kolchfa-aws Feb 6, 2024
0382604
Vale error
kolchfa-aws Feb 6, 2024
7f4499b
Updated field names
kolchfa-aws Feb 6, 2024
56c148c
Add updating credentials
kolchfa-aws Feb 6, 2024
00d53a9
Added tools table
kolchfa-aws Feb 6, 2024
afc9ac6
Add OpenSearch forum thread for OS Assistant
kolchfa-aws Feb 7, 2024
36bf022
Merge branch 'main' into agent-framework
kolchfa-aws Feb 8, 2024
7583223
Add tech review for conv search
kolchfa-aws Feb 8, 2024
92e2af7
Fix links
kolchfa-aws Feb 8, 2024
16943ed
Add tools
kolchfa-aws Feb 10, 2024
6185c1d
Add links to tools
kolchfa-aws Feb 10, 2024
3f61951
More info about tools
kolchfa-aws Feb 12, 2024
ba3983f
Tool parameters
kolchfa-aws Feb 12, 2024
70eab78
Update cat-index-tool.md
kolchfa-aws Feb 12, 2024
e7671b8
Parameter clarification
kolchfa-aws Feb 13, 2024
eaf1f46
Tech review feedback
kolchfa-aws Feb 13, 2024
c8d7c3c
Typo fix
kolchfa-aws Feb 13, 2024
76833f7
More tech review feedback: RAG tool
kolchfa-aws Feb 13, 2024
9044eaf
Tech review feedback: memory APis
kolchfa-aws Feb 13, 2024
1a0e818
Update _ml-commons-plugin/agents-tools/index.md
kolchfa-aws Feb 14, 2024
8369db2
Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md
kolchfa-aws Feb 14, 2024
31d7690
Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md
kolchfa-aws Feb 14, 2024
efeaca4
Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md
kolchfa-aws Feb 14, 2024
3881fb0
Update _ml-commons-plugin/opensearch-assistant.md
kolchfa-aws Feb 14, 2024
8d9b2fe
Update _ml-commons-plugin/agents-tools/tools/ppl-tool.md
kolchfa-aws Feb 14, 2024
544456d
Apply suggestions from code review
kolchfa-aws Feb 14, 2024
bf49d69
Separated search and get APIs and add conversational flow agent
kolchfa-aws Feb 14, 2024
96343b2
More parameters for PPL tool
kolchfa-aws Feb 14, 2024
33b3d2b
Added more parameters
kolchfa-aws Feb 15, 2024
c3ecb48
Tech review feedback: PPL tool
kolchfa-aws Feb 15, 2024
9cced21
Apply suggestions from code review
kolchfa-aws Feb 15, 2024
aaba606
Resolve merge conflicts
kolchfa-aws Feb 15, 2024
de47bf9
Rename to automating configurations
kolchfa-aws Feb 15, 2024
01ab264
Editorial comments on the new text
kolchfa-aws Feb 16, 2024
bb7e0a3
Merge conflicts
kolchfa-aws Feb 16, 2024
e78a542
Add parameter to PPl tool
kolchfa-aws Feb 16, 2024
a28e5d8
Changed link to configurations
kolchfa-aws Feb 16, 2024
31beeb9
Resolve merge conflicts and add links to UI assistant
kolchfa-aws Feb 19, 2024
0ccdc7f
Rate limiter feedback and added warning
kolchfa-aws Feb 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/vale/styles/Vocab/OpenSearch/Products/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Open Distro
OpenAI
OpenID Connect
OpenSearch
OpenSearch Assistant
OpenSearch Benchmark
OpenSearch Dashboards
OpenSearch Playground
Expand Down
19 changes: 10 additions & 9 deletions _dashboards/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Here's a glance at the view you see when you open the **Dashboard** or **Discove

{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/alert-icon.png" class="inline-icon" alt="alert icon"/>{:/} **Note**<br>Before you get started, make sure you've installed OpenSearch and OpenSearch Dashboards. For information about installation and configuration, see [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/) and [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/).
{: .note}
# Adding sample data

## Adding sample data

Sample datasets come with visualizations, dashboards, and other tools to help you explore Dashboards before you add your own data. To add sample data, perform the following steps:

Expand All @@ -31,15 +32,15 @@ Sample datasets come with visualizations, dashboards, and other tools to help yo

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-sample-data.png" alt="Sample datasets" width="700">

# Exploring and inspecting data
## Exploring and inspecting data

In [**Discover**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/), you can:

- Choose data to explore, set a time range for that data, search it using [Dashboards Query Language (DQL)]({{site.url}}{{site.baseurl}}/dashboards/dql/), and filter the results.
- Explore the data, view individual documents, and create tables summarizing the data.
- Visualize your findings.

## Try it: Getting familiar with Discover
### Try it: Getting familiar with Discover

1. On the OpenSearch Dashboards **Home** page, choose **Discover**.
1. Change the [time filter]({{site.url}}{{site.baseurl}}/dashboards/discover/time-filter/) to **Last 7 days**, as shown in the following image.
Expand All @@ -54,7 +55,7 @@ In [**Discover**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discove

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/filter-data-discover.png" alt="Filter data by FlightDelayType field" width="250"/>

# Visualizing data
## Visualizing data

Raw data can be difficult to comprehend and use. Data visualizations help you prepare and present data in a visual form. In **Dashboard** you can:

Expand All @@ -63,7 +64,7 @@ Raw data can be difficult to comprehend and use. Data visualizations help you pr
- Create and share reports.
- Embed analytics to differentiate your applications.

## Try it: Getting familiar with Dashboard
### Try it: Getting familiar with Dashboard

1. On the OpenSearch Dashboards **Home** page, choose **Dashboard**.
1. Choose **[Flights] Global Flight Data** in the **Dashboards** window, as shown in the following image.
Expand All @@ -77,7 +78,7 @@ Raw data can be difficult to comprehend and use. Data visualizations help you pr

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-panel.png" alt="Add panel to dashboard" width="700"/>

## Try it: Creating a visualization panel
### Try it: Creating a visualization panel

Continuing with the preceding dashboard, you'll create a bar chart comparing the number of canceled flights and delayed flights to delay type and then add the panel to the dashboard:

Expand All @@ -92,11 +93,11 @@ Continuing with the preceding dashboard, you'll create a bar chart comparing the

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/viz-panel-quickstart.png" alt="Creating a visualization panel" width="700"/>

# Interacting with data
## Interacting with data

Interactive dashboards allow you analyze data in more depth and filter it in several ways. In Dashboards, you can interact directly with data on a dashboard by using dashboard-level filters. For example, continuing with the preceding dashboard, you can filter to show delays and cancellations for a specific airline.

## Try it: Interacting with the sample flight data
### Try it: Interacting with the sample flight data

1. On the **[Flights] Airline Carrier** panel, choose **OpenSearch-Air**. The dashboard updates automatically.
1. Choose **Save** to save the customized dashboard.
Expand All @@ -112,7 +113,7 @@ Alternatively, you can apply filters using the dashboard toolbar:

<img src="{{site.url}}{{site.baseurl}}/images/interact-filter-dashboard.png" alt="Dashboard view after applying Carrier filter" width="700"/>

# Next steps
## Next steps

- **Visualize data**. To learn more about data visualizations in OpenSearch Dashboards, see [**Building data visualizations**]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/).
- **Create dashboards**. To learn more about creating dashboards in OpenSearch Dashboards, see [**Creating dashboards**]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/).
Expand Down
Loading
Loading