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.

Sign up for GitHub

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

Jump to bottom

add tutorial for building your own chatbot #2144

Merged
merged 5 commits into from
Feb 21, 2024
Merged

add tutorial for building your own chatbot #2144

merged 5 commits into from
Feb 21, 2024

Conversation

ylwu-amzn
Copy link
Collaborator

Description

Add tutorial for how to build your own chatbot in OpenSearch with Agent Framework.

Issues Resolved

[List any issues this PR will resolve]

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:12 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:12 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:12 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:13 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:13 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:13 — with GitHub Actions Inactive
@codecov Codecov
Copy link

codecov bot commented Feb 21, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0903d5d) 81.85% compared to head (f991c6f) 81.85%.

❗ Current head f991c6f differs from pull request most recent head f5c96c6. Consider uploading reports for the commit f5c96c6 to get more accurate results

Additional details and impacted files 
@@             Coverage Diff              @@
##               main    #2144      +/-   ##
============================================
- Coverage     81.85%   81.85%   -0.01%     
+ Complexity     5660     5659       -1     
============================================
  Files           543      543              
  Lines         22857    22857              
  Branches       2350     2350              
============================================
- Hits          18710    18709       -1     
- Misses         3207     3209       +2     
+ Partials        940      939       -1
Flag Coverage Δ
ml-commons 81.85% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:40 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:40 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 02:40 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 05:15 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 05:15 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 05:15 — with GitHub Actions Inactive
@ylwu-amzn
fix some example request
8b76b1c 
Signed-off-by: Yaliang Wu <[email protected]>
@ylwu-amzn ylwu-amzn force-pushed the maint_custom_chatbot branch from 1d58af0 to 8b76b1c Compare February 21, 2024 05:38
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 05:38 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 06:43 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 07:10 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 07:10 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 07:10 — with GitHub Actions Inactive
kolchfa-aws
kolchfa-aws reviewed Feb 21, 2024
View reviewed changes
Copy link
Contributor

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some clarifying rewrites.

docs/tutorials/agent_framework/build_your_own_chatbot.md Outdated

A root chatbot agent consists of
- `conversational` agent: You can use any `conversational` agent in `AgentTool` created in previous steps.
- `MLModelTool`: This is for suggesting new questions based on your current question and model response.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `MLModelTool`: This is for suggesting new questions based on your current question and model response.
- `MLModelTool`: This tool is used for suggesting new questions based on your current question and the model response.

docs/tutorials/agent_framework/build_your_own_chatbot.md Outdated
}
}
```
Note the root chatbot agent id, then login your OpenSearch server, go to OpenSearch config folder `$OS_HOME/config` and run this
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note the root chatbot agent id, then login your OpenSearch server, go to OpenSearch config folder `$OS_HOME/config` and run this
Note the root chatbot agent ID, then log in to your OpenSearch server, go to OpenSearch config folder `$OS_HOME/config` and run the following command:

docs/tutorials/agent_framework/build_your_own_chatbot.md Outdated
}'
```

Go to your OpenSearch Dashboard config folder, `$OSD_HOME/config`, edit `opensearch_dashboards.yml` by adding this line to the end `assistant.chat.enabled: true`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Go to your OpenSearch Dashboard config folder, `$OSD_HOME/config`, edit `opensearch_dashboards.yml` by adding this line to the end `assistant.chat.enabled: true`
Go to your OpenSearch Dashboards config folder, `$OSD_HOME/config`, edit `opensearch_dashboards.yml` by adding the following line to the end: `assistant.chat.enabled: true`.

docs/tutorials/agent_framework/build_your_own_chatbot.md Outdated

Go to your OpenSearch Dashboard config folder, `$OSD_HOME/config`, edit `opensearch_dashboards.yml` by adding this line to the end `assistant.chat.enabled: true`

Restart OpenSearch Dashboard, click the chat icon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Restart OpenSearch Dashboard, click the chat icon
Restart OpenSearch Dashboards, then select the chat icon, as shown in the following image.

docs/tutorials/agent_framework/build_your_own_chatbot.md Outdated

![Alt text](images/chatbot/osd_chatbot_1.png)

Then chat on OpenSearch Dashboard
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Then chat on OpenSearch Dashboard
You can now chat in OpenSearch Dashboards, as shown in the following image.

@ylwu-amzn @kolchfa-aws
Apply suggestions from code review
f991c6f 
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:19 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:19 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:19 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:20 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:20 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:20 — with GitHub Actions Inactive
@ylwu-amzn @kolchfa-aws
Apply suggestions from code review
f5c96c6 
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:21 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:21 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:21 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:21 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:21 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn merged commit bdf62cf into opensearch-project:main Feb 21, 2024
8 of 9 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 21, 2024
@ylwu-amzn @github-actions
add tutorial for building your own chatbot (#2144)
29c0ae8 
* add tutorial for building your own chatbot

Signed-off-by: Yaliang Wu <[email protected]>

* fix some example request

Signed-off-by: Yaliang Wu <[email protected]>

* fine tune

Signed-off-by: Yaliang Wu <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>

---------

Signed-off-by: Yaliang Wu <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit bdf62cf)
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Feb 21, 2024
Merged
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:49 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:49 — with GitHub Actions Inactive
@ylwu-amzn ylwu-amzn temporarily deployed to ml-commons-cicd-env February 21, 2024 22:49 — with GitHub Actions Inactive
ylwu-amzn added a commit that referenced this pull request Feb 21, 2024
@opensearch-trigger-bot @ylwu-amzn
add tutorial for building your own chatbot (#2144) (#2146)
0b98158 
* add tutorial for building your own chatbot

Signed-off-by: Yaliang Wu <[email protected]>

* fix some example request

Signed-off-by: Yaliang Wu <[email protected]>

* fine tune

Signed-off-by: Yaliang Wu <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>

---------

Signed-off-by: Yaliang Wu <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit bdf62cf)

Co-authored-by: Yaliang Wu <[email protected]>
austintlee pushed a commit to austintlee/ml-commons that referenced this pull request Mar 19, 2024
@ylwu-amzn @kolchfa-aws @austin-aryn-ai
add tutorial for building your own chatbot (opensearch-project#2144)
15f2a42 
* add tutorial for building your own chatbot

Signed-off-by: Yaliang Wu <[email protected]>

* fix some example request

Signed-off-by: Yaliang Wu <[email protected]>

* fine tune

Signed-off-by: Yaliang Wu <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Yaliang Wu <[email protected]>

---------

Signed-off-by: Yaliang Wu <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kolchfa-aws kolchfa-aws kolchfa-aws left review comments

@dhrubo-os dhrubo-os dhrubo-os approved these changes

@b4sjoo b4sjoo b4sjoo approved these changes

@jngz-es jngz-es Awaiting requested review from jngz-es jngz-es is a code owner

@model-collapse model-collapse Awaiting requested review from model-collapse model-collapse is a code owner

@rbhavna rbhavna Awaiting requested review from rbhavna rbhavna is a code owner

@zane-neo zane-neo Awaiting requested review from zane-neo zane-neo is a code owner

@Zhangxunmt Zhangxunmt Awaiting requested review from Zhangxunmt Zhangxunmt is a code owner

@austintlee austintlee Awaiting requested review from austintlee austintlee is a code owner

@HenryL27 HenryL27 Awaiting requested review from HenryL27 HenryL27 is a code owner

@sam-herman sam-herman Awaiting requested review from sam-herman

Assignees
No one assigned
Labels
backport 2.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ylwu-amzn @kolchfa-aws @dhrubo-os @b4sjoo