Files
elasticsearch-js/docs/reference/api/QueryDslQueryContainer.md
2025-05-27 15:30:21 -05:00

12 KiB

Interface QueryDslQueryContainer

Name Type Description
bool QueryDslBoolQuery matches documents matching boolean combinations of other queries.
boosting QueryDslBoostingQuery Returns documents matching a positive query while reducing the relevance score of documents that also match a negative query.
combined_fields QueryDslCombinedFieldsQuery The combined_fields query supports searching multiple text fields as if their contents had been indexed into one combined field.
common Partial<Record<Field, QueryDslCommonTermsQuery string>>
constant_score QueryDslConstantScoreQuery Wraps a filter query and returns every matching document with a relevance score equal to the boost parameter value.
dis_max QueryDslDisMaxQuery Returns documents matching one or more wrapped queries, called query clauses or clauses. If a returned document matches multiple query clauses, the dis_max query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.
distance_feature QueryDslDistanceFeatureQuery Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location.
exists QueryDslExistsQuery Returns documents that contain an indexed value for a field.
function_score QueryDslFunctionScoreQuery QueryDslFunctionScoreContainer[]
fuzzy Partial<Record<Field, QueryDslFuzzyQuery string
geo_bounding_box QueryDslGeoBoundingBoxQuery Matches geo_point and geo_shape values that intersect a bounding box.
geo_distance QueryDslGeoDistanceQuery Matches geo_point and geo_shape values within a given distance of a geopoint.
geo_grid Partial<Record<Field, QueryDslGeoGridQuery>> Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.
geo_polygon QueryDslGeoPolygonQuery  
geo_shape QueryDslGeoShapeQuery Filter documents indexed using either the geo_shape or the geo_point type.
has_child QueryDslHasChildQuery Returns parent documents whose joined child documents match a provided query.
has_parent QueryDslHasParentQuery Returns child documents whose joined parent document matches a provided query.
ids QueryDslIdsQuery Returns documents based on their IDs. This query uses document IDs stored in the _id field.
intervals Partial<Record<Field, QueryDslIntervalsQuery>> Returns documents based on the order and proximity of matching terms.
knn KnnQuery Finds the k nearest vectors to a query vector, as measured by a similarity metric. knn query finds nearest vectors through approximate search on indexed dense_vectors.
match_all QueryDslMatchAllQuery Matches all documents, giving them all a _score of 1.0.
match_bool_prefix Partial<Record<Field, QueryDslMatchBoolPrefixQuery string>>
match_none QueryDslMatchNoneQuery Matches no documents.
match_phrase_prefix Partial<Record<Field, QueryDslMatchPhrasePrefixQuery string>>
match_phrase Partial<Record<Field, QueryDslMatchPhraseQuery string>>
match Partial<Record<Field, QueryDslMatchQuery string
more_like_this QueryDslMoreLikeThisQuery Returns documents that are "like" a given set of documents.
multi_match QueryDslMultiMatchQuery Enables you to search for a provided text, number, date or boolean value across multiple fields. The provided text is analyzed before matching.
nested QueryDslNestedQuery Wraps another query to search nested fields. If an object matches the search, the nested query returns the root parent document.
parent_id QueryDslParentIdQuery Returns child documents joined to a specific parent document.
percolate QueryDslPercolateQuery Matches queries stored in an index.
pinned QueryDslPinnedQuery Promotes selected documents to rank higher than those matching a given query.
prefix Partial<Record<Field, QueryDslPrefixQuery string>>
query_string QueryDslQueryStringQuery Returns documents based on a provided query string, using a parser with a strict syntax.
range Partial<Record<Field, QueryDslRangeQuery>> Returns documents that contain terms within a provided range.
rank_feature QueryDslRankFeatureQuery Boosts the relevance score of documents based on the numeric value of a rank_feature or rank_features field.
regexp Partial<Record<Field, QueryDslRegexpQuery string>>
rule QueryDslRuleQuery  
script_score QueryDslScriptScoreQuery Uses a script to provide a custom score for returned documents.
script QueryDslScriptQuery Filters documents based on a provided script. The script query is typically used in a filter context.
semantic QueryDslSemanticQuery A semantic query to semantic_text field types
shape QueryDslShapeQuery Queries documents that contain fields indexed using the shape type.
simple_query_string QueryDslSimpleQueryStringQuery Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.
span_containing QueryDslSpanContainingQuery Returns matches which enclose another span query.
span_field_masking QueryDslSpanFieldMaskingQuery Wrapper to allow span queries to participate in composite single-field span queries by lying about their search field.
span_first QueryDslSpanFirstQuery Matches spans near the beginning of a field.
span_multi QueryDslSpanMultiTermQuery Allows you to wrap a multi term query (one of wildcard, fuzzy, prefix, range, or regexp query) as a span query, so it can be nested.
span_near QueryDslSpanNearQuery Matches spans which are near one another. You can specify slop, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.
span_not QueryDslSpanNotQuery Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter pre) or y tokens after (controlled by the parameter post) another span query.
span_or QueryDslSpanOrQuery Matches the union of its span clauses.
span_term Partial<Record<Field, QueryDslSpanTermQuery FieldValue>>
span_within QueryDslSpanWithinQuery Returns matches which are enclosed inside another span query.
sparse_vector QueryDslSparseVectorQuery Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.
term Partial<Record<Field, QueryDslTermQuery FieldValue>>
terms_set Partial<Record<Field, QueryDslTermsSetQuery>> Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
terms QueryDslTermsQuery Returns documents that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.
text_expansion Partial<Record<Field, QueryDslTextExpansionQuery>> Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
type QueryDslTypeQuery  
weighted_tokens Partial<Record<Field, QueryDslWeightedTokensQuery>> Supports returning text_expansion query results by sending in precomputed tokens with the query.
wildcard Partial<Record<Field, QueryDslWildcardQuery string>>
wrapper QueryDslWrapperQuery A query that accepts any other query as base64 encoded string.