Get multiple term vectors

POST also GET /{index}/_mtermvectors
POST also GET /_mtermvectors

Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a docs array with all the fetched termvectors. Each element has the structure provided by the termvectors API.

Artificial documents

You can also use mtermvectors to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified _index.

Required authorization

Authentication

Authorization: <value>

Elasticsearch APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

Path parameters

Query parameters

ids string[]

A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body

fields union oneOf

A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

One of: string[] or string

field_statistics boolean · default: true

If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

offsets boolean · default: true

If true, the response includes term offsets.

payloads boolean · default: true

If true, the response includes term payloads.

positions boolean · default: true

If true, the response includes term positions.

preference string

The node or shard the operation should be performed on. It is random by default.

realtime boolean · default: true

If true, the request is real-time as opposed to near-real-time.

routing union oneOf

A custom value used to route operations to a specific shard. Not allowed when index.slice.enabled is true for the target index; use _slice instead.

One of: string[] or string

term_statistics boolean · default: false

If true, the response includes term frequency and document frequency.

version number

If true, returns the document version as part of a hit.

version_type enum

The version type.

Supported values include:

internal: Use internal versioning that starts at 1 and increments with each update or delete.
external: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.
external_gte: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document. NOTE: The external_gte version type is meant for special use cases and should be used with care. If used incorrectly, it can result in loss of data.

Values: internal external external_gte

Request body

docs object[]: An array of existing or artificial documents.
ids string[]: A simplified syntax to specify documents by their ID if they're in the same index.

Response

application/json

Examples

Request Console 1 / 8 languages

Run POST /my-index-000001/_mtermvectors. When you specify an index in the request URI, the index does not need to be specified for each documents in the request body.

Console Kibana Dev Tools

POST /my-index-000001/_mtermvectors
{
  "docs": [
      {
        "_id": "2",
        "fields": [
            "message"
        ],
        "term_statistics": true
      },
      {
        "_id": "1"
      }
  ]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.mtermvectors({
  index: "my-index-000001",
  docs: [
    {
      _id: "2",
      fields: ["message"],
      term_statistics: true,
    },
    {
      _id: "1",
    },
  ],
});

Python Elasticsearch Python Client

resp = client.mtermvectors(
    index="my-index-000001",
    docs=[
        {
            "_id": "2",
            "fields": [
                "message"
            ],
            "term_statistics": True
        },
        {
            "_id": "1"
        }
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_mtermvectors" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docs": [
      {
        "_id": "2",
        "fields": [
          "message"
        ],
        "term_statistics": true
      },
      {
        "_id": "1"
      }
    ]
  }'

Java Elasticsearch Java Client

client.mtermvectors(m -> m
    .docs(List.of(MultiTermVectorsOperation.of(mu -> mu
            .id("2")
            .fields("message")
            .termStatistics(true)
        ),MultiTermVectorsOperation.of(mu -> mu
            .id("1")
        )))
    .index("my-index-000001")
);

C# Elasticsearch .NET Client

var response = await client
    .MtermvectorsAsync(d1 => d1
        .Index("my-index-000001")
        .Docs(d2 => d2
            .Fields(x => x.Message)
            .Id("2")
            .TermStatistics(true), d2 => d2
            .Id("1")
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->mtermvectors([
    "index" => "my-index-000001",
    "body" => [
        "docs" => array(
            [
                "_id" => "2",
                "fields" => array(
                    "message",
                ),
                "term_statistics" => true,
            ],
            [
                "_id" => "1",
            ],
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.mtermvectors(
  index: "my-index-000001",
  body: {
    "docs": [
      {
        "_id": "2",
        "fields": [
          "message"
        ],
        "term_statistics": true
      },
      {
        "_id": "1"
      }
    ]
  }
)

Response

No example

Request Console 1 / 2 languages

Run POST /my-index-000001/_mtermvectors. If all requested documents are in same index and the parameters are the same, you can use a simplified syntax.

Console Kibana Dev Tools

POST /my-index-000001/_mtermvectors
{
  "ids": [ "1", "2" ],
  "fields": [
    "message"
  ],
  "term_statistics": true
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_mtermvectors" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [ "1", "2" ],
    "fields": [
      "message"
    ],
    "term_statistics": true
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Run POST /_mtermvectors to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified _index.

Console Kibana Dev Tools

POST /_mtermvectors
{
  "docs": [
      {
        "_index": "my-index-000001",
        "doc" : {
            "message" : "test test test"
        }
      },
      {
        "_index": "my-index-000001",
        "doc" : {
          "message" : "Another test ..."
        }
      }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_mtermvectors" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "docs": [
        {
          "_index": "my-index-000001",
          "doc" : {
              "message" : "test test test"
          }
        },
        {
          "_index": "my-index-000001",
          "doc" : {
            "message" : "Another test ..."
          }
        }
    ]
  }'

Generated from the API spec

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body