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 Task, Tools APIs #797

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

nathaliellenaa
Copy link
Contributor

@nathaliellenaa nathaliellenaa commented Jan 16, 2025

Description

Added missing ML Task and Tools APIs.

Issues Resolved

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

ML Task, Tools APIs to add

  • GET /_plugins/_ml/tasks/_search
  • POST /_plugins/_ml/tasks/_search
  • GET /_plugins/_ml/tools
  • GET /_plugins/_ml/tools/{tool_name}

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 <[email protected]>
Copy link
Contributor

Changes Analysis

Commit SHA: d050306
Comparing To SHA: 1422af3

API Changes

Summary

├─┬Paths
│ ├──[➕] path (5746:3)
│ ├──[➕] path (5761:3)
│ ├──[➕] path (5682:3)
│ └─┬/_plugins/_ml/tasks/{task_id}
│   ├─┬GET
│   │ └─┬Extensions
│   │   └──[➕] x-version-added (5734:24)
│   └─┬DELETE
│     └─┬Extensions
│       └──[➕] x-version-added (5719:24)
└─┬Components
  ├──[➕] requestBodies (28623:7)
  ├──[➕] responses (32200:7)
  ├──[➕] responses (32079:7)
  ├──[➕] parameters (23956:7)
  ├──[➖] schemas (56505:7)❌ 
  ├──[➖] schemas (56985:7)❌ 
  ├──[➖] schemas (56947:7)❌ 
  ├──[➖] schemas (55715:7)❌ 
  ├──[➖] schemas (56337:7)❌ 
  ├──[➕] schemas (55720:7)
  ├──[➕] schemas (56731:7)
  ├──[➕] schemas (55961:7)
  ├──[➕] schemas (55850:7)
  ├─┬ml._common___Term
  │ └──[➕] properties (57126:9)
  ├─┬ml._common___Task
  │ ├─┬function_name
  │ │ └──[🔀] $ref (55850:13)❌ 
  │ └─┬task_type
  │   ├──[➕] enum (57093:15)
  │   ├──[➕] enum (57086:15)
  │   ├──[➕] enum (57087:15)
  │   ├──[➕] enum (57089:15)
  │   ├──[➕] enum (57090:15)
  │   └──[➕] enum (57092:15)
  ├─┬ml._common___AlgorithmOperations
  │ ├──[➕] properties (55747:9)
  │ ├─┬deploy
  │ │ └──[🔀] $ref (56327:13)❌ 
  │ ├─┬register
  │ │ └──[🔀] $ref (56327:13)❌ 
  │ ├─┬train
  │ │ └──[🔀] $ref (56327:13)❌ 
  │ ├─┬predict
  │ │ └──[🔀] $ref (56327:13)❌ 
  │ └─┬undeploy
  │   └──[🔀] $ref (56327:13)❌ 
  ├─┬ml._common___Source
  │ ├──[➕] properties (57051:9)
  │ ├──[➕] properties (57021:9)
  │ ├──[➕] properties (57023:9)
  │ ├──[➕] properties (57018:9)
  │ ├──[➕] properties (56899:9)
  │ ├──[➕] properties (57049:9)
  │ ├──[➕] properties (57037:9)
  │ ├──[➕] properties (57033:9)
  │ └─┬create_time
  │   ├──[➖] type (56819:17)❌ 
  │   ├──[➖] format (56820:19)❌ 
  │   ├──[➕] anyOf (56973:15)
  │   └──[➕] anyOf (56971:15)
  └─┬ml._common___ModelProfile
    ├──[➕] properties (56320:9)
    ├─┬train
    │ └──[🔀] $ref (56327:13)❌ 
    ├─┬undeploy
    │ └──[🔀] $ref (56327:13)❌ 
    ├─┬deploy
    │ └──[🔀] $ref (56327:13)❌ 
    ├─┬register
    │ └──[🔀] $ref (56327:13)❌ 
    └─┬predict
      └──[🔀] $ref (56327:13)❌ 

Document Element Total Changes Breaking Changes
components 45 18
paths 5 0
  • BREAKING Changes: 18 out of 50
  • Modifications: 11
  • Removals: 7
  • Additions: 32
  • Breaking Removals: 7
  • Breaking Modifications: 11

Report

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

API Coverage

Before After Δ
Covered (%) 655 (64.15 %) 659 (64.54 %) 4 (0.39 %)
Uncovered (%) 366 (35.85 %) 362 (35.46 %) -4 (-0.39 %)
Unknown 44 44 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
590 589 (99.83 %)

@dblock dblock merged commit 639fd57 into opensearch-project:main Jan 16, 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.

3 participants