fix the tutorial in AIConnectorHelper when fetching domain_url #3852

Zhangxunmt · 2025-05-15T17:19:22Z

Description

This fixes the error when calling describe_elasticsearch_domain to get domain_url for VPC domains. For VPC domains, the returned Endpoints is a Map rather than a String.
https://docs.aws.amazon.com/cli/latest/reference/es/describe-elasticsearch-domain.html

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

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.

nathaliellenaa · 2025-05-15T17:45:08Z

docs/tutorials/aws/AIConnectorHelper.ipynb

    "            domain_arn = domain_info['ARN']\n",
    "\n",
+    "        # Check if domain has VPC endpoints\n",
+    "        if 'Endpoints' in domain_info:\n",


I used this logic to check for VPC endpoint in the connector CLI. Maybe you can try this out since this is simpler? (ref)

domain_url = ( domain_info.get("Endpoint") or domain_info["Endpoints"]["vpc"] )

If Endpoints or vpc does not exist, it would throw KeyError if key doesn't exist so you need to run this tutorial from begin.

I see, that makes sense.

codecov · 2025-05-15T18:24:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.02%. Comparing base (f6a25f5) to head (ba049e7).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #3852   +/-   ##
=========================================
  Coverage     78.01%   78.02%           
- Complexity     7336     7337    +1     
=========================================
  Files           656      656           
  Lines         33074    33074           
  Branches       3708     3708           
=========================================
+ Hits          25804    25805    +1     
  Misses         5683     5683           
+ Partials       1587     1586    -1

Flag	Coverage Δ
ml-commons	`78.02% <ø> (+<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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

nathaliellenaa

LGTM

Signed-off-by: Xun Zhang <[email protected]>

ylwu-amzn · 2025-05-21T21:26:25Z

Thanks for the fix. Can you also fix this https://github.com/opensearch-project/ml-commons/blob/main/docs/tutorials/aws/DeepSeek_demo_notebook_for_RAG.ipynb

Signed-off-by: Xun Zhang <[email protected]>

Zhangxunmt · 2025-06-03T20:52:26Z

Thanks for the fix. Can you also fix this https://github.com/opensearch-project/ml-commons/blob/main/docs/tutorials/aws/DeepSeek_demo_notebook_for_RAG.ipynb

done.

dhrubo-os · 2025-06-03T20:55:38Z

docs/tutorials/aws/AIConnectorHelper.ipynb

+    "            # Check if domain has VPC endpoints\n",
+    "            if 'Endpoints' in domain_info:\n",
+    "                # VPC domain case\n",
+    "                if 'vpc' in domain_info['Endpoints']:\n",


So for VPC endpoints there are multiple endpoints? Trying to understand the Endpoints objects. What else does this contain?

It returned a Map including 'vpc':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

…earch-project#3852) * fix the tutorial in AIConnectorHelper when fetching domain_url Signed-off-by: Xun Zhang <[email protected]> * fix for deepseek notebook Signed-off-by: Xun Zhang <[email protected]> --------- Signed-off-by: Xun Zhang <[email protected]>

…earch-project#3852) * fix the tutorial in AIConnectorHelper when fetching domain_url Signed-off-by: Xun Zhang <[email protected]> * fix for deepseek notebook Signed-off-by: Xun Zhang <[email protected]> --------- Signed-off-by: Xun Zhang <[email protected]> Signed-off-by: Abdul Muneer Kolarkunnu <[email protected]>

Zhangxunmt requested review from b4sjoo, dhrubo-os, mingshl, jngz-es, model-collapse, rbhavna, ylwu-amzn, zane-neo, austintlee, HenryL27 and xinyual as code owners May 15, 2025 17:19

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 15, 2025 17:21 — with GitHub Actions Inactive

nathaliellenaa reviewed May 15, 2025

View reviewed changes

Zhangxunmt had a problem deploying to ml-commons-cicd-env May 15, 2025 18:24 — with GitHub Actions Failure

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 15, 2025 18:24 — with GitHub Actions Inactive

nathaliellenaa approved these changes May 21, 2025

View reviewed changes

jngz-es previously approved these changes May 21, 2025

View reviewed changes

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 21, 2025 20:51 — with GitHub Actions Inactive

Zhangxunmt dismissed jngz-es’s stale review via 6700334 May 21, 2025 20:53

Zhangxunmt force-pushed the mainline branch from 463cc0e to 6700334 Compare May 21, 2025 20:53

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 21, 2025 20:54 — with GitHub Actions Inactive

fix the tutorial in AIConnectorHelper when fetching domain_url

Loading
Loading status checks…

1ac9077

Signed-off-by: Xun Zhang <[email protected]>

Zhangxunmt force-pushed the mainline branch from 6700334 to 1ac9077 Compare May 21, 2025 20:57

Zhangxunmt had a problem deploying to ml-commons-cicd-env May 21, 2025 20:59 — with GitHub Actions Failure

Zhangxunmt had a problem deploying to ml-commons-cicd-env May 21, 2025 20:59 — with GitHub Actions Error

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 21, 2025 20:59 — with GitHub Actions Inactive

ylwu-amzn previously approved these changes May 21, 2025

View reviewed changes

fix for deepseek notebook

Loading
Loading status checks…

ba049e7

Signed-off-by: Xun Zhang <[email protected]>

Zhangxunmt dismissed ylwu-amzn’s stale review via ba049e7 May 21, 2025 23:58

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 22, 2025 00:00 — with GitHub Actions Inactive

Zhangxunmt had a problem deploying to ml-commons-cicd-env May 22, 2025 00:00 — with GitHub Actions Failure

Zhangxunmt temporarily deployed to ml-commons-cicd-env May 22, 2025 00:00 — with GitHub Actions Inactive

Zhangxunmt had a problem deploying to ml-commons-cicd-env May 22, 2025 00:00 — with GitHub Actions Error

Merge branch 'main' into mainline

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

GPG key ID: B5690EEEBB952194

Verified
Learn about vigilant mode

Loading
Loading status checks…

180205b

Zhangxunmt had a problem deploying to ml-commons-cicd-env June 3, 2025 20:54 — with GitHub Actions Error

Zhangxunmt had a problem deploying to ml-commons-cicd-env June 3, 2025 20:54 — with GitHub Actions Failure

Zhangxunmt had a problem deploying to ml-commons-cicd-env June 3, 2025 20:54 — with GitHub Actions Error

Zhangxunmt had a problem deploying to ml-commons-cicd-env June 3, 2025 20:54 — with GitHub Actions Failure

jngz-es approved these changes Jun 3, 2025

View reviewed changes

dhrubo-os reviewed Jun 3, 2025

View reviewed changes

dhrubo-os approved these changes Jun 3, 2025

View reviewed changes

Zhangxunmt merged commit ac35832 into opensearch-project:main Jun 3, 2025
6 of 10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix the tutorial in AIConnectorHelper when fetching domain_url #3852

fix the tutorial in AIConnectorHelper when fetching domain_url #3852

Zhangxunmt commented May 15, 2025 •

edited

Loading

Uh oh!

nathaliellenaa May 15, 2025 •

edited

Loading

Uh oh!

Zhangxunmt May 21, 2025

Uh oh!

nathaliellenaa May 21, 2025

Uh oh!

codecov bot commented May 15, 2025 •

edited

Loading

Uh oh!

nathaliellenaa left a comment

Uh oh!

ylwu-amzn commented May 21, 2025

Uh oh!

Zhangxunmt commented Jun 3, 2025

Uh oh!

dhrubo-os Jun 3, 2025

Uh oh!

Zhangxunmt Jun 3, 2025

Uh oh!

Uh oh!

fix the tutorial in AIConnectorHelper when fetching domain_url #3852

fix the tutorial in AIConnectorHelper when fetching domain_url #3852

Conversation

Zhangxunmt commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

nathaliellenaa May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Zhangxunmt May 21, 2025

Choose a reason for hiding this comment

Uh oh!

nathaliellenaa May 21, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nathaliellenaa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ylwu-amzn commented May 21, 2025

Uh oh!

Uh oh!

Zhangxunmt commented Jun 3, 2025

Uh oh!

Uh oh!

dhrubo-os Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

Zhangxunmt Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Zhangxunmt commented May 15, 2025 •

edited

Loading

nathaliellenaa May 15, 2025 •

edited

Loading

codecov bot commented May 15, 2025 •

edited

Loading