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

Update guide for 2.12 changes with Agent Framework #123

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

lezzago
Copy link
Member

@lezzago lezzago commented Jan 31, 2024

Description

Update guide for 2.12 changes with Agent Framework

Issues Resolved

N/A

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test.
  • New functionality has user manual doc 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.

Copy link

codecov bot commented Jan 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d6378e6) 95.35% compared to head (e963bac) 95.35%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #123   +/-   ##
=======================================
  Coverage   95.35%   95.35%           
=======================================
  Files          48       48           
  Lines        1269     1269           
  Branches      308      314    +6     
=======================================
  Hits         1210     1210           
  Misses         57       57           
  Partials        2        2           

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

Copy link
Member

@joshuali925 joshuali925 left a comment

Choose a reason for hiding this comment

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

minor comments, thanks

3. If you want to enable the chat assistant feature, set `assistant.chat.enabled` to `true` in the `opensearch_dashboards.yml` file.
1. Setup a 2.12+ OpenSearch cluster with OpenSearch Dashboards by following the options here: https://opensearch.org/docs/latest/install-and-configure/
1. Note: If you are using a min distribution, there are required OpenSearch and OpenSearch Dashboards plugin to run the assistant.
1. Required OpenSearch plugins: ML-Commons, Flow Framework, and Observability
Copy link
Member

Choose a reason for hiding this comment

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

i think https://github.com/opensearch-project/skills is also required? It contains PPL tools and other tools. Maybe also SQL plugin for executing PPL in query assist?

},
"type": "flow"
}
}
Copy link
Member

Choose a reason for hiding this comment

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

i think this is missing PPL agent used by query assist

        {
          "id": "ppl_agent",
          "type": "register_agent",
          "previous_node_inputs": {
            "TransferQuestionToPPLAndExecuteTool": "tools"
          },
          "user_inputs": {
            "parameters": {},
            "app_type": "query_assist",
            "name": "PPL agent",
            "description": "this is the PPL agent",
            "type": "flow"
          }
        }

Copy link
Member

@joshuali925 joshuali925 left a comment

Choose a reason for hiding this comment

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

thanks

@joshuali925 joshuali925 merged commit cce5e1f into opensearch-project:main Feb 1, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants