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

Added ML Model APIs #733

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nathaliellenaa
Copy link
Contributor

@nathaliellenaa nathaliellenaa commented Dec 13, 2024

Description

Added GET /_plugins/_ml/models/{id}, POST /_plugins/_ml/models/_search, and PUT /_plugins/_ml/models/{id}.

Issues Resolved

Part of opensearch-project/opensearch-py#867.

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.

…h the tests

Signed-off-by: Nathalie Jonathan <nathhjo@amazon.com>
Copy link
Contributor

Changes Analysis

Commit SHA: 1420d16
Comparing To SHA: dd7fd9a

API Changes

Summary

├─┬Paths
│ ├─┬/_plugins/_ml/models/{model_id}
│ │ ├──[➕] get (4802:7)
│ │ └──[➕] put (4816:7)
│ └─┬/_plugins/_ml/models/_search
│   └──[➕] post (4772:7)
└─┬Components
  ├──[➕] requestBodies (27240:7)
  ├──[➕] responses (30335:7)
  ├──[➕] responses (30282:7)
  ├──[➕] parameters (22919:7)
  ├──[➕] parameters (22901:7)
  ├──[➕] schemas (54080:7)
  ├──[➕] schemas (53726:7)
  ├──[➕] schemas (53844:7)
  ├──[➕] schemas (53686:7)
  └──[➕] schemas (53655:7)

Document Element Total Changes Breaking Changes
paths 3 0
components 10 0
  • Total Changes: 13
  • Additions: 13

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12323574180/artifacts/2319624073

API Coverage

Before After Δ
Covered (%) 606 (59.35 %) 609 (59.65 %) 3 (0.3 %)
Uncovered (%) 415 (40.65 %) 412 (40.35 %) -3 (-0.3 %)
Unknown 43 43 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
539 490 (90.91 %)

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Looking good. I have some smallish nits. Iterate to green (validation is failing, etc.)

CHANGELOG.md Show resolved Hide resolved
tests/plugins/ml/ml/models.yaml Show resolved Hide resolved
tests/plugins/ml/ml/models.yaml Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@dblock
Copy link
Member

dblock commented Dec 13, 2024

Btw, there's a whole bunch of others missing per #168. They don't all need to be done at the same time.

Screenshot 2024-12-13 at 5 07 47 PM

@nathaliellenaa
Copy link
Contributor Author

Yes, I'm planning to create some small PRs based on the APIs category (model, model groups, connector, agents, etc.) I will also add more missing Model APIs to this PR.

@nathaliellenaa nathaliellenaa changed the title Added missing ML Model APIs to the spec along with the tests Added ML Model APIs Dec 14, 2024
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