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.

Sign up for GitHub

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

Jump to bottom

add accurate numeric type in DSL #597

Merged
merged 2 commits into from
Oct 2, 2024
Merged

add accurate numeric type in DSL #597

merged 2 commits into from
Oct 2, 2024

Conversation

amberzsy
Copy link
Contributor

@amberzsy amberzsy commented Oct 2, 2024

Description

spec field --> OpenSearch Core reference link

boost -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/QueryBuilder.java#L85

cutoff_frequency -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java#L352C54-L352C64

tie_breaker -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/DisMaxQueryBuilder.java#L64C31-L64C50

max_boost -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/functionscore/FunctionScoreQueryBuilder.java#L559

min_score -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreQueryBuilder.java#L100

weight -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/common/lucene/search/function/WeightFactorFunction.java#L52

factor -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/common/lucene/search/function/FieldValueFactorFunction.java#L71

missing -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/common/lucene/search/function/FieldValueFactorFunction.java#L73

seed -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/functionscore/RandomScoreFunctionBuilder.java#L101

max_expansions -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java#L68C29-L68C51

prefix_length -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java#L65

max_children -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/search/sort/NestedSortBuilder.java#L159

max_gaps -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/IntervalsSourceProvider.java#L243

prefix_length -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java#L65

slop -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java#L137

https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java#L107

max_doc_freq -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java#L103

max_query_terms -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java#L100

MAX_WORD_LENGTH -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java#L105

MIN_DOC_FREQ -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java#L102

min_score -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreQueryBuilder.java#L100C19-L100C27

max_distance -> https://github.com/opensearch-project/neural-search/blob/10ad4737e4a356f54068bd074881a46db0741610/src/main/java/org/opensearch/neuralsearch/query/NeuralQueryBuilder.java#L274

fuzzy_max_expansions -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java#L80

fuzzy_prefix_length -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java#L79

max_determinized_states -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java#L711

PHRASE_SLOP_FIELD -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java#L723

pivot -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/modules/mapper-extras/src/main/java/org/opensearch/index/query/RankFeatureQueryBuilder.java#L222

exponent -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/modules/mapper-extras/src/main/java/org/opensearch/index/query/RankFeatureQueryBuilder.java#L225

scaling_factor -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/modules/mapper-extras/src/main/java/org/opensearch/index/query/RankFeatureQueryBuilder.java#L85

max_determinized_states -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/search/suggest/completion/RegexOptions.java#L124

fuzzy_max_expansions -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/SimpleQueryStringBuilder.java#L104

fuzzy_prefix_length -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/SimpleQueryStringBuilder.java#L102

end -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/IntervalBuilder.java#L275

dist -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java#L132

post -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java#L158

pre -> https://github.com/opensearch-project/OpenSearch/blob/1ee858fc8cc631d35c4a48b2a53d4ab6009e2c2b/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java#L142

Issues Resolved

#596

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.

@amberzsy
add CHANGELOG
4e1a290 
Signed-off-by: amberzsy <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Changes Analysis

Commit SHA: 4e1a290
Comparing To SHA: 939a292

API Changes

Summary

└─┬Components
  ├─┬_common.query_dsl:HasChildQuery
  │ └─┬ALLOF
  │   ├─┬max_children
  │   │ └──[➕] format (39245:23)❌ 
  │   └─┬min_children
  │     └──[➕] format (39251:23)❌ 
  ├─┬_common.query_dsl:SpanNotQuery
  │ └─┬ALLOF
  │   ├─┬dist
  │   │ └──[➕] format (40590:23)❌ 
  │   ├─┬pre
  │   │ └──[➕] format (40602:23)❌ 
  │   └─┬post
  │     └──[➕] format (40598:23)❌ 
  ├─┬_common.query_dsl:RankFeatureFunctionLogarithm
  │ └─┬ALLOF
  │   └─┬scaling_factor
  │     └──[➕] format (40320:23)❌ 
  ├─┬_common.query_dsl:FunctionScoreQuery
  │ └─┬ALLOF
  │   ├─┬max_boost
  │   │ └──[➕] format (39107:23)❌ 
  │   └─┬min_score
  │     └──[➕] format (39111:23)❌ 
  ├─┬_common.query_dsl:MoreLikeThisQuery
  │ └─┬ALLOF
  │   ├─┬min_word_length
  │   │ └──[➕] format (39696:23)❌ 
  │   ├─┬min_term_freq
  │   │ └──[➕] format (39692:23)❌ 
  │   ├─┬min_doc_freq
  │   │ └──[➕] format (39686:23)❌ 
  │   ├─┬max_doc_freq
  │   │ └──[➕] format (39672:23)❌ 
  │   ├─┬boost_terms
  │   │ └──[➕] format (39648:23)❌ 
  │   ├─┬max_query_terms
  │   │ └──[➕] format (39676:23)❌ 
  │   └─┬max_word_length
  │     └──[➕] format (39682:23)❌ 
  ├─┬_common.query_dsl:RankFeatureFunctionSaturation
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (40307:13)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (40326:11)❌ 
  ├─┬_common.query_dsl:MultiMatchQuery
  │ └─┬ALLOF
  │   ├─┬cutoff_frequency
  │   │ └──[➕] format (39733:23)❌ 
  │   ├─┬slop
  │   │ └──[➕] format (39766:23)❌ 
  │   ├─┬tie_breaker
  │   │ └──[➕] format (39770:23)❌ 
  │   ├─┬max_expansions
  │   │ └──[➕] format (39751:23)❌ 
  │   └─┬prefix_length
  │     └──[➕] format (39759:23)❌ 
  ├─┬_common.query_dsl:CommonTermsQuery
  │ └─┬ALLOF
  │   └─┬cutoff_frequency
  │     └──[➕] format (38880:23)❌ 
  ├─┬_common.query_dsl:SpanNearQuery
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (40564:11)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (39964:13)❌ 
  ├─┬_common.query_dsl:ScriptScoreQuery
  │ └─┬ALLOF
  │   └─┬min_score
  │     └──[➕] format (40428:23)❌ 
  ├─┬_common.query_dsl:FunctionScoreContainer
  │ └─┬ALLOF
  │   └─┬weight
  │     └──[➕] format (39066:23)❌ 
  ├─┬_common.query_dsl:QueryStringQuery
  │ └─┬ALLOF
  │   ├─┬fuzzy_max_expansions
  │   │ └──[➕] format (40231:23)❌ 
  │   ├─┬fuzzy_prefix_length
  │   │ └──[➕] format (40235:23)❌ 
  │   ├─┬max_determinized_states
  │   │ └──[➕] format (40247:23)❌ 
  │   ├─┬phrase_slop
  │   │ └──[➕] format (40253:23)❌ 
  │   └─┬tie_breaker
  │     └──[➕] format (40272:23)❌ 
  ├─┬_common.query_dsl:MatchPhrasePrefixQuery
  │ └─┬ALLOF
  │   ├─┬slop
  │   │ └──[➕] format (39561:23)❌ 
  │   └─┬max_expansions
  │     └──[➕] format (39554:23)❌ 
  ├─┬_common.query_dsl:DisMaxQuery
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (39964:13)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (38946:11)❌ 
  ├─┬_common.query_dsl:MatchPhraseQuery
  │ └─┬ALLOF
  │   └─┬slop
  │     └──[➕] format (39580:23)❌ 
  ├─┬_common.query_dsl:IntervalsMatch
  │ └─┬max_gaps
  │   └──[➕] format (39402:19)❌ 
  ├─┬_common.query_dsl:MatchBoolPrefixQuery
  │ └─┬ALLOF
  │   ├─┬prefix_length
  │   │ └──[➕] format (39531:23)❌ 
  │   └─┬max_expansions
  │     └──[➕] format (39521:23)❌ 
  ├─┬_common.query_dsl:FuzzyQuery
  │ └─┬ALLOF
  │   ├─┬max_expansions
  │   │ └──[➕] format (39124:23)❌ 
  │   └─┬prefix_length
  │     └──[➕] format (39128:23)❌ 
  ├─┬_common.query_dsl:IntervalsFuzzy
  │ └─┬prefix_length
  │   └──[➕] format (39380:19)❌ 
  ├─┬_common.query_dsl:SimpleQueryStringQuery
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (40459:11)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (39964:13)❌ 
  ├─┬_common.query_dsl:QueryBase
  │ └─┬boost
  │   └──[➕] format (39973:19)❌ 
  ├─┬_common.query_dsl:NeuralQueryVectorField
  │ ├─┬max_distance
  │ │ └──[➕] format (39826:19)❌ 
  │ └─┬min_score
  │   └──[➕] format (39823:19)❌ 
  ├─┬_common.query_dsl:BoostingQuery
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (38812:11)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (39964:13)❌ 
  ├─┬_common.query_dsl:RegexpQuery
  │ └─┬ALLOF
  │   └─┬max_determinized_states
  │     └──[➕] format (40381:23)❌ 
  ├─┬_common.query_dsl:SpanFirstQuery
  │ └─┬ALLOF
  │   └─┬end
  │     └──[➕] format (40539:23)❌ 
  ├─┬_common.query_dsl:RankFeatureFunctionSigmoid
  │ └─┬ALLOF
  │   ├─┬exponent
  │   │ └──[➕] format (40344:23)❌ 
  │   └─┬pivot
  │     └──[➕] format (40340:23)❌ 
  ├─┬_common.query_dsl:RandomScoreFunction
  │ └─┬seed
  │   ├─┬ONEOF
  │   │ └──[🔀] type (40288:21)❌ 
  │   └─┬ONEOF
  │     ├──[🔀] type (40286:21)❌ 
  │     └──[➕] format (40287:23)❌ 
  ├─┬_common.query_dsl:IntervalsAllOf
  │ └─┬max_gaps
  │   └──[➕] format (39309:19)❌ 
  ├─┬_common.query_dsl:MatchQuery
  │ └─┬ALLOF
  │   ├─┬max_expansions
  │   │ └──[➕] format (39613:23)❌ 
  │   ├─┬cutoff_frequency
  │   │ └──[➕] format (39599:23)❌ 
  │   └─┬prefix_length
  │     └──[➕] format (39621:23)❌ 
  └─┬_common.query_dsl:FieldValueFactorScoreFunction
    ├─┬factor
    │ └──[➕] format (39038:19)❌ 
    └─┬missing
      └──[➕] format (39044:19)❌
Document Element Total Changes Breaking Changes
components 63 115
  • ❌ BREAKING Changes: 115 out of 63
  • Modifications: 12
  • Additions: 51
  • Breaking Modifications: 12
  • Breaking Additions: 51

Report

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

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 29 29 0

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Spec Test Coverage Analysis

Total Tested
504 303 (60.12 %)

@dblock dblock merged commit 62da9f4 into opensearch-project:main Oct 2, 2024
18 checks passed
@amberzsy amberzsy mentioned this pull request Oct 11, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dblock dblock dblock approved these changes

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@nhtruong nhtruong Awaiting requested review from nhtruong nhtruong is a code owner

@Xtansia Xtansia Awaiting requested review from Xtansia Xtansia is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@Tokesh Tokesh Awaiting requested review from Tokesh Tokesh is a code owner

@aabeshov aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@amberzsy @dblock