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 Memory APIs #771

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Conversation

nathaliellenaa
Copy link
Contributor

@nathaliellenaa nathaliellenaa commented Jan 7, 2025

Description

Added missing ML Memory APIs.

Issues Resolved

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

ML Memory APIs to add

  • POST /_plugins/_ml/memory
  • PUT /_plugins/_ml/memory/{memory_id}
  • GET /_plugins/_ml/memory
  • GET /_plugins/_ml/memory/{memory_id}
  • GET /_plugins/_ml/memory/_search
  • POST /_plugins/_ml/memory/_search
  • DELETE /_plugins/_ml/memory/{memory_id}
  • POST /_plugins/_ml/memory/{memory_id}/messages
  • PUT /_plugins/_ml/memory/message/{message_id}
  • GET /_plugins/_ml/memory/message/{message_id}
  • GET /_plugins/_ml/memory/{memory_id}/messages
  • GET /_plugins/_ml/memory/{memory_id}/_search
  • POST /_plugins/_ml/memory/{memory_id}/_search
  • GET /_plugins/_ml/memory/message/{message_id}/traces

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.

Copy link
Contributor

github-actions bot commented Jan 7, 2025

Changes Analysis

Commit SHA: b073571
Comparing To SHA: 9c8431f

API Changes

Summary

├─┬Paths
│ ├──[➕] path (4883:3)
│ ├──[➕] path (4933:3)
│ ├──[➕] path (5034:3)
│ ├──[➕] path (4968:3)
│ ├──[➕] path (5001:3)
│ ├──[➕] path (4850:3)
│ └──[➕] path (4817:3)
└─┬Components
  ├──[➕] requestBodies (27895:7)
  ├──[➕] requestBodies (27584:7)
  ├──[➕] requestBodies (27903:7)
  ├──[➕] requestBodies (27592:7)
  ├──[➕] requestBodies (27612:7)
  ├──[➕] requestBodies (27769:7)
  ├──[➕] requestBodies (27752:7)
  ├──[➕] responses (30947:7)
  ├──[➕] responses (31104:7)
  ├──[➕] responses (31033:7)
  ├──[➕] responses (31039:7)
  ├──[➕] responses (31045:7)
  ├──[➕] responses (31152:7)
  ├──[➕] responses (30981:7)
  ├──[➕] responses (31158:7)
  ├──[➕] responses (30958:7)
  ├──[➕] responses (31110:7)
  ├──[➕] parameters (23310:7)
  ├──[➕] parameters (23256:7)
  ├──[➕] parameters (23340:7)
  ├──[➕] parameters (23298:7)
  ├──[➕] parameters (23304:7)
  ├──[➕] parameters (23376:7)
  ├──[➕] parameters (23292:7)
  ├──[➕] parameters (23238:7)
  ├──[➕] parameters (23370:7)
  ├──[➕] schemas (55237:7)
  ├──[➕] schemas (54866:7)
  ├──[➕] schemas (54582:7)
  ├──[➕] schemas (55166:7)
  ├──[➕] schemas (55259:7)
  ├──[➕] schemas (54753:7)
  ├──[➕] schemas (54740:7)
  ├──[➕] schemas (54762:7)
  ├──[➕] schemas (55168:7)
  ├─┬ml._common___SearchHits
  │ └─┬max_score
  │   ├──[🔀] type (55129:13)❌ 
  │   └──[➖] format (54566:19)❌ 
  ├─┬ml._common___Memory
  │ ├──[➕] properties (54863:9)
  │ ├──[➕] properties (54850:9)
  │ ├──[➕] properties (54848:9)
  │ ├──[➕] properties (54858:9)
  │ ├──[➕] properties (54854:9)
  │ └──[➕] properties (54860:9)
  ├─┬ml._common___SearchHitsHit
  │ └──[➕] properties (55157:9)
  ├─┬ml._common___Source
  │ ├──[➕] properties (55431:9)
  │ ├──[➕] properties (55426:9)
  │ ├──[➕] properties (55422:9)
  │ ├──[➕] properties (55436:9)
  │ ├──[➕] properties (55441:9)
  │ ├──[➕] properties (55453:9)
  │ ├──[➕] properties (55458:9)
  │ ├──[➕] properties (55463:9)
  │ ├──[➕] properties (55448:9)
  │ ├──[➕] properties (55443:9)
  │ ├──[➕] properties (55418:9)
  │ ├──[➕] properties (55433:9)
  │ └─┬name
  │   └──[🔀] $ref (34057:13)❌ 
  ├─┬ml._common___Query
  │ └──[➕] properties (55093:9)
  ├─┬ml._common___Match
  │ └──[➕] additionalProperties (54838:29)❌ 
  └─┬ml._common___Term
    └──[➕] properties (55532:9)

Document Element Total Changes Breaking Changes
paths 7 0
components 60 4
  • BREAKING Changes: 4 out of 67
  • Modifications: 2
  • Removals: 1
  • Additions: 64
  • Breaking Removals: 1
  • Breaking Modifications: 2
  • Breaking Additions: 1

Report

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

API Coverage

Before After Δ
Covered (%) 616 (60.33 %) 630 (61.7 %) 14 (1.37 %)
Uncovered (%) 405 (39.67 %) 391 (38.3 %) -14 (-1.37 %)
Unknown 43 43 0

…APIs, updated max_score schema type and test description in memory/update.yaml.

Signed-off-by: Nathalie Jonathan <[email protected]>
Copy link
Contributor

github-actions bot commented Jan 8, 2025

Spec Test Coverage Analysis

Total Tested
560 560 (100 %)

@dblock dblock merged commit 2395cb4 into opensearch-project:main Jan 8, 2025
39 checks passed
@nathaliellenaa nathaliellenaa deleted the add-ml-memory-api branch January 9, 2025 21:42
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