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

Renamed explanation response processor to hybrid_score_explanation #1085

Conversation

martin-gaievski
Copy link
Member

@martin-gaievski martin-gaievski commented Jan 9, 2025

Description

Change the name of the new response processor from explanation_response_processor to hybrid_score_explanation. New name is more consistent with naming conventions for other search processors by dropping the response_processor suffix (https://opensearch.org/docs/latest/search-plugins/search-pipelines/search-processors/) and reflects the hybrid search specialization. Came up with the new name while working on the documentation PR for explainability opensearch-project/documentation-website#8645

with new processor name this is how the pipeline will look like:

{
    "description": "Post processor for hybrid search",
    "phase_results_processors": [
        {
            "normalization-processor": {
                "normalization": {
                    "technique": "min_max"
                },
                "combination": {
                    "technique": "arithmetic_mean",
                    "parameters": {
                        "weights": [
                            0.3,
                            0.7
                        ]
                    }
                }
            }
        }
    ],
    "response_processors": [
        {
            "hybrid_score_explanation": {}
        }
    ]
}

Related Issues

#905

Check List

  • [ ] New functionality includes testing.
  • [ ] New functionality has been documented.
  • [ ] API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • [ ] Public documentation issue/PR created.

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.

@martin-gaievski martin-gaievski merged commit b4cb267 into opensearch-project:main Jan 9, 2025
61 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 9, 2025
Signed-off-by: Martin Gaievski <[email protected]>
(cherry picked from commit b4cb267)
martin-gaievski added a commit that referenced this pull request Jan 9, 2025
Signed-off-by: Martin Gaievski <[email protected]>
(cherry picked from commit b4cb267)

Co-authored-by: Martin Gaievski <[email protected]>
martin-gaievski added a commit that referenced this pull request Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Label will add auto workflow to backport PR to 2.x branch skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants