-
Notifications
You must be signed in to change notification settings - Fork 31
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 query assist data summary agent template #875
Open
chishui
wants to merge
3
commits into
opensearch-project:main
Choose a base branch
from
chishui:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+166
−0
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
94 changes: 94 additions & 0 deletions
94
sample-templates/query-assist-data-summary-agent-claude-tested.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| { | ||
| "name": "Query Assist Data Summary Agent", | ||
| "description": "Create Query Assist Data Summary Agent using Claude on BedRock", | ||
| "use_case": "REGISTER_AGENT", | ||
| "version": { | ||
| "template": "1.0.0", | ||
| "compatibility": ["2.17.0", "3.0.0"] | ||
| }, | ||
| "workflows": { | ||
| "provision": { | ||
| "user_params": {}, | ||
| "nodes": [ | ||
| { | ||
| "id": "create_claude_connector", | ||
| "type": "create_connector", | ||
| "previous_node_inputs": {}, | ||
| "user_inputs": { | ||
| "version": "1", | ||
| "name": "Claude instant runtime Connector", | ||
| "protocol": "aws_sigv4", | ||
| "description": "The connector to BedRock service for Claude model", | ||
| "actions": [ | ||
| { | ||
| "headers": { | ||
| "x-amz-content-sha256": "required", | ||
| "content-type": "application/json" | ||
| }, | ||
| "method": "POST", | ||
| "request_body": "{\"prompt\":\"${parameters.prompt}\", \"max_tokens_to_sample\":${parameters.max_tokens_to_sample}, \"temperature\":${parameters.temperature}, \"anthropic_version\":\"${parameters.anthropic_version}\" }", | ||
| "action_type": "predict", | ||
| "url": "https://bedrock-runtime.us-west-2.amazonaws.com/model/anthropic.claude-instant-v1/invoke" | ||
| } | ||
| ], | ||
| "credential": { | ||
| "access_key": "<YOUR_ACCESS_KEY>", | ||
| "secret_key": "<YOUR_SECRET_KEY>", | ||
| "session_token": "<YOUR_SESSION_TOKEN>" | ||
| }, | ||
| "parameters": { | ||
| "region": "us-west-2", | ||
| "endpoint": "bedrock-runtime.us-west-2.amazonaws.com", | ||
| "content_type": "application/json", | ||
| "auth": "Sig_V4", | ||
| "max_tokens_to_sample": "8000", | ||
| "service_name": "bedrock", | ||
| "temperature": "0.0001", | ||
| "response_filter": "$.completion", | ||
| "anthropic_version": "bedrock-2023-05-31" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "id": "register_claude_model", | ||
| "type": "register_remote_model", | ||
| "previous_node_inputs": { | ||
| "create_claude_connector": "connector_id" | ||
| }, | ||
| "user_inputs": { | ||
| "description": "Claude model", | ||
| "deploy": true, | ||
| "name": "claude-instant" | ||
| } | ||
| }, | ||
| { | ||
| "id": "create_query_assist_data_summary_ml_model_tool", | ||
| "type": "create_tool", | ||
| "previous_node_inputs": { | ||
| "register_claude_model": "model_id" | ||
| }, | ||
| "user_inputs": { | ||
| "parameters": { | ||
| "prompt": "Human: You are an assistant that helps to summarize the data and provide data insights.\nThe data are queried from OpenSearch index through user's question which was translated into PPL query.\nHere is a sample PPL query: `source=<index> | where <field> = <value>`.\nNow you are given ${parameters.sample_count} sample data out of ${parameters.total_count} total data.\nThe user's question is `${parameters.question}`, the translated PPL query is `${parameters.ppl}` and sample data are:\n```\n${parameters.sample_data}\n```\nCould you help provide a summary of the sample data and provide some useful insights with precise wording and in plain text format, do not use markdown format.\nYou don't need to echo my requirements in response.\n\nAssistant:" | ||
| }, | ||
| "name": "MLModelTool", | ||
| "type": "MLModelTool" | ||
| } | ||
| }, | ||
| { | ||
| "id": "create_query_assist_data_summary_agent", | ||
| "type": "register_agent", | ||
| "previous_node_inputs": { | ||
| "create_query_assist_data_summary_ml_model_tool": "tools" | ||
| }, | ||
| "user_inputs": { | ||
| "parameters": {}, | ||
| "type": "flow", | ||
| "name": "Query Assist Data Summary Agent", | ||
| "description": "this is an query assist data summary agent" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
71 changes: 71 additions & 0 deletions
71
sample-templates/query-assist-data-summary-agent-claude-tested.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| name: Query Assist Data Summary Agent | ||
| description: Create Query Assist Data Summary Agent using Claude on BedRock | ||
| use_case: REGISTER_AGENT | ||
| version: | ||
| template: 1.0.0 | ||
| compatibility: | ||
| - 2.17.0 | ||
| - 3.0.0 | ||
| workflows: | ||
| provision: | ||
| user_params: {} | ||
| nodes: | ||
| - id: create_claude_connector | ||
| type: create_connector | ||
| previous_node_inputs: {} | ||
| user_inputs: | ||
| version: '1' | ||
| name: Claude instant runtime Connector | ||
| protocol: aws_sigv4 | ||
| description: The connector to BedRock service for Claude model | ||
| actions: | ||
| - headers: | ||
| x-amz-content-sha256: required | ||
| content-type: application/json | ||
| method: POST | ||
| request_body: '{"prompt":"${parameters.prompt}", "max_tokens_to_sample":${parameters.max_tokens_to_sample}, | ||
| "temperature":${parameters.temperature}, "anthropic_version":"${parameters.anthropic_version}" | ||
| }' | ||
| action_type: predict | ||
| url: https://bedrock-runtime.us-west-2.amazonaws.com/model/anthropic.claude-instant-v1/invoke | ||
| credential: | ||
| access_key: "<YOUR_ACCESS_KEY>" | ||
| secret_key: "<YOUR_SECRET_KEY>" | ||
| session_token: "<YOUR_SESSION_TOKEN>" | ||
| parameters: | ||
| region: us-west-2 | ||
| endpoint: bedrock-runtime.us-west-2.amazonaws.com | ||
| content_type: application/json | ||
| auth: Sig_V4 | ||
| max_tokens_to_sample: '8000' | ||
| service_name: bedrock | ||
| temperature: '0.0001' | ||
| response_filter: "$.completion" | ||
| anthropic_version: bedrock-2023-05-31 | ||
| - id: register_claude_model | ||
| type: register_remote_model | ||
| previous_node_inputs: | ||
| create_claude_connector: connector_id | ||
| user_inputs: | ||
| description: Claude model | ||
| deploy: true | ||
| name: claude-instant | ||
| - id: create_query_assist_data_summary_ml_model_tool | ||
| type: create_tool | ||
| previous_node_inputs: | ||
| register_claude_model: model_id | ||
| user_inputs: | ||
| parameters: | ||
| prompt: "Human: You are an assistant that helps to summarize the data and provide data insights.\nThe data are queried from OpenSearch index through user's question which was translated into PPL query.\nHere is a sample PPL query: `source=<index> | where <field> = <value>`.\nNow you are given ${parameters.sample_count} sample data out of ${parameters.total_count} total data.\nThe user's question is `${parameters.question}`, the translated PPL query is `${parameters.ppl}` and sample data are:\n```\n${parameters.sample_data}\n```\nCould you help provide a summary of the sample data and provide some useful insights with precise wording and in plain text format, do not use markdown format.\nYou don't need to echo my requirements in response.\n\nAssistant:" | ||
| name: MLModelTool | ||
| type: MLModelTool | ||
| - id: create_query_assist_data_summary_agent | ||
| type: register_agent | ||
| previous_node_inputs: | ||
| create_alert_summary_ml_model_tool: tools | ||
| user_inputs: | ||
| parameters: {} | ||
| type: flow | ||
| name: Query Assist Data Summary Agent | ||
| description: this is an query assist data summary agent |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a comment on this PR, but note to other reviewers. I wonder if there's a way we can (probably in ML Commons) not require these to be specified in the connector, but instead have them pulled in real time using CredentialsProviders like the AWS SDK client does.