API version: dev

---

# `ElasticsearchQueryDslMixinStep`

## Properties

Extends: [`BaseStep`](/openapi-schema/base-step.md)

- `type`: `enum` — required

- `query`: `object` — required

  An Elasticsearch Query DSL object.

  example: `{"match":{"description":{"query":"lily"}}}`

- `parameters`: `object` — optional

  Step-local parameters. In addition to arbitrary values used by expressions inside `query`, this step recognizes the following well-known keys.
  - `nodeTypes`: `string[]` — optional

    Restricts the search to the given node types.

  - `relationTypes`: `string[]` — optional

    Restricts the search to the given relation types.

  - `page`: `integer` — optional

    Page of results to return.

  - `pageSize`: `integer` — optional

    Number of results per page.

  - `minScore`: `number` — optional

    If set, removes all results with a lower Elasticsearch relevance score.

## Raw Schema

```json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseStep"
    },
    {
      "type": "object",
      "required": [
        "type",
        "query"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "elasticsearch-query-dsl-mixin"
          ]
        },
        "query": {
          "type": "object",
          "additionalProperties": true,
          "description": "An Elasticsearch Query DSL object.",
          "example": {
            "match": {
              "description": {
                "query": "lily"
              }
            }
          }
        },
        "parameters": {
          "type": "object",
          "additionalProperties": true,
          "description": "Step-local parameters. In addition to arbitrary values used by expressions inside `query`, this step recognizes the following well-known keys.",
          "properties": {
            "nodeTypes": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Restricts the search to the given node types."
            },
            "relationTypes": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Restricts the search to the given relation types."
            },
            "page": {
              "type": "integer",
              "default": 1,
              "description": "Page of results to return."
            },
            "pageSize": {
              "type": "integer",
              "default": 25,
              "description": "Number of results per page."
            },
            "minScore": {
              "type": "number",
              "nullable": true,
              "default": null,
              "description": "If set, removes all results with a lower Elasticsearch relevance score."
            }
          }
        }
      }
    }
  ]
}
```

---

Home: [Ember Nexus API docs](/index.md)

Full site map: [llms.txt](/llms.txt)