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

Add ML Agent APIs #798

Merged
merged 1 commit into from
Jan 17, 2025
Merged

Conversation

nathaliellenaa
Copy link
Contributor

@nathaliellenaa nathaliellenaa commented Jan 16, 2025

Description

Added missing ML Agent APIs.

Issues Resolved

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

ML Agent APIs to add

  • POST /_plugins/_ml/agents/{agent_id}/_execute
  • GET /_plugins/_ml/agents/{agent_id}
  • GET /_plugins/_ml/agents/_search
  • POST /_plugins/_ml/agents/_search

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.

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

Changes Analysis

Commit SHA: 7158456
Comparing To SHA: 639fd57

API Changes

Summary

├─┬Paths
│ ├──[➕] path (4804:3)
│ ├──[➕] path (4740:3)
│ ├─┬/_plugins/_ml/agents/_register
│ │ └─┬POST
│ │   └─┬Extensions
│ │     └──[➕] x-version-added (4727:24)
│ ├─┬/_plugins/_ml/models/_register
│ │ └─┬POST
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[➕] properties (32291:15)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         ├──[➖] required (28470:17)❌ 
│ │         ├──[➕] properties (28564:15)
│ │         └──[➕] properties (28561:15)
│ └─┬/_plugins/_ml/agents/{agent_id}
│   ├──[➕] get (4790:7)
│   └─┬DELETE
│     └─┬Extensions
│       └──[➕] x-version-added (4777:24)
└─┬Components
  ├──[➕] requestBodies (28636:7)
  ├──[➕] requestBodies (28447:7)
  ├──[➕] responses (32076:7)
  ├──[➕] responses (32298:7)
  ├──[➕] responses (32070:7)
  ├──[➕] parameters (23900:7)
  ├──[➕] parameters (23894:7)
  ├──[➕] schemas (56007:7)
  ├──[➕] schemas (57396:7)
  ├──[➕] schemas (56827:7)
  ├──[➕] schemas (56952:7)
  ├─┬ml._common___Query
  │ └──[➕] additionalProperties (56788:29)❌ 
  ├─┬ml._common___ToolItems
  │ └──[➕] properties (57356:9)
  ├─┬ml._common___Term
  │ └──[➕] properties (57345:9)
  ├─┬ml._common___SearchHitsHit
  │ └─┬_score
  │   ├──[🔀] type (56863:13)❌ 
  │   └──[➖] format (56693:19)❌ 
  ├─┬ml._common___Source
  │ ├──[➕] properties (57226:9)
  │ ├──[➕] properties (57224:9)
  │ ├──[➕] properties (57220:9)
  │ └──[➕] properties (57213:9)
  └─┬ml._common___Output
    └──[➕] properties (56608:9)

Document Element Total Changes Breaking Changes
paths 9 1
components 21 3
  • BREAKING Changes: 4 out of 30
  • Modifications: 1
  • Removals: 2
  • Additions: 27
  • Breaking Removals: 2
  • Breaking Modifications: 1
  • Breaking Additions: 1

Report

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

API Coverage

Before After Δ
Covered (%) 659 (64.54 %) 663 (64.94 %) 4 (0.4 %)
Uncovered (%) 362 (35.46 %) 358 (35.06 %) -4 (-0.4 %)
Unknown 44 44 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
594 592 (99.66 %)

@dblock dblock merged commit 3965b31 into opensearch-project:main Jan 17, 2025
42 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