Add Search APIs for Search Relevance#1064
Add Search APIs for Search Relevance#1064ajleong623 wants to merge 15 commits intoopensearch-project:mainfrom
Conversation
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
Proto Compatibility ReportMerge ReportNo changes detected. Generated by Proto Compatibility Check |
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
Changes AnalysisCommit SHA: 4cf56a6 API ChangesSummaryNo changes found between specifications ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/24438918894/artifacts/6443992045 API Coverage
|
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
|
I am not 100% sure if the api specs should be added with the version of OpenSearch that is being pushed or after the version has been pushed. I am also working on passing tests before I switch to "ready for review". |
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
|
When adding the tests, I added the new apis as a new synopsis to test files that were already there. However, the version of OpenSearch where those initial tests were created was 3.1. However, the new apis are added for 3.5. Therefore, I put the version assertion of |
|
Just wanted to share that we are actively using these annotations in the Here is an example: opensearch-project/opensearch-mcp-server-py#187 When this goes in, we'll push for another release of the |
epugh
left a comment
There was a problem hiding this comment.
I dropped in a few questions...
| operationId: search_relevance.post_search_configurations.1 | ||
| x-operation-group: search_relevance.post_search_configurations | ||
| x-version-added: '3.5' | ||
| description: Searches for search configurations. |
There was a problem hiding this comment.
funny, yet accurate wording ;-)
| size: | ||
| type: integer | ||
| format: int64 | ||
| description: The number of tasks to return. |
There was a problem hiding this comment.
Is this correct? tasks? or queries?
There was a problem hiding this comment.
It should be queries. Thank you.
| size: | ||
| type: integer | ||
| format: int64 | ||
| description: The number of tasks to return. |
There was a problem hiding this comment.
same question on the descirption as above..
| size: | ||
| type: integer | ||
| format: int64 | ||
| description: The number of tasks to return. |
There was a problem hiding this comment.
maybe it's a more generic "number of items to return" across all of these?
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
|
Hi all, this PR has been sitting for a while, and we want to get it in for 3.6.. I'm pinging recently active maintainers ;-). @harshavamsi @lucy66hw for some help! |
…ong623/aj-opensearch-api-specification into search_relevance_search_api
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
Signed-off-by: Anthony Leong <aj.leong623@gmail.com>
|
Thanks for poking away at this @ajleong623 ... Are the test failures related to |
|
@karenyrx I have tried running my initial pr, however, the test with just OpenSearch 2.0.0 failed. After commenting out all my changes, I still have version 2.0.0 failing. In fact a couple other test versions failed with the other api spec changes. Is there anything I am missing or is the failing test affecting other PRs in general? |
|
@epugh I think the errors are unrelated to the changes I made based on reading them. |
|
@Xtansia when my pr was up, all the tests passed except for OpenSearch version 2.0.0. Currently I commented all my changes out, and the test is still failing as well as a couple of unrelated ones. What could I do to have the pr merged? |
Description
This change adds the recently-created search apis for the search relevance repository. These include:
These give more flexibility in searching through the objects needed for search relevance. The issue and linked PRs are here: opensearch-project/search-relevance#351
Issues Resolved
N/A
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.