Get multiple term vectors | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
• 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.
• If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
• If true, the response includes term offsets.
• If true, the response includes term payloads.
• If true, the response includes term positions.
• The node or shard the operation should be performed on. It is random by default.
• If true, the request is real-time as opposed to near-real-time.
• A custom value used to route operations to a specific shard.
• If true, the response includes term frequency and document frequency.
• If true, returns the document version as part of a hit.
• 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.
  • force: This option is deprecated because it can cause primary and replica shards to diverge.
    Values are internal, external, external_gte, or force.

application/json

Body

• An array of existing or artificial documents.
  Hide docs attributes Show docs attributes object
  • An artificial document (a document not present in the index) for which you want to retrieve term vectors.
  • If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
  • Hide filter attributes Show filter attributes object
    * Ignore words which occur in more than this many docs. Defaults to unbounded.
    * The maximum number of terms that must be returned per field.
    * Ignore words with more than this frequency in the source doc. It defaults to unbounded.
    * The maximum word length above which words will be ignored. Defaults to unbounded.
    * Ignore terms which do not occur in at least this many docs.
    * Ignore words with less than this frequency in the source doc.
    * The minimum word length below which words will be ignored.
  • If true, the response includes term offsets.
  • If true, the response includes term payloads.
  • If true, the response includes term positions.
  • If true, the response includes term frequency and document frequency.
  • Values are internal, external, external_gte, or force.
• A simplified syntax to specify documents by their ID if they're in the same index.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • docs
    array[object] Required
    Hide docs attributes Show docs attributes object
    * Hide term_vectors attribute Show term_vectors attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide field_statistics attributes Show field_statistics attributes object
    * Hide terms attribute Show terms attribute object
    * *
    object Additional properties
    * Hide error attributes Show error attributes object
    * The type of error
    * A human-readable explanation of the error, in English.
    * The server stack trace. Present only if the error_trace=true parameter was sent with the request.