Get term vector information | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• 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 (how many documents contain this field).
  • The sum of document frequencies (the sum of document frequencies for all terms in this field).
  • The sum of total term frequencies (the sum of total term frequencies of each term in this field).
• 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 that is used to route operations to a specific shard.
• If true, the response includes:
  • The total term frequency (how often a term occurs in all documents).
  • The document frequency (the number of documents containing the current term).
    By default these values are not returned since term statistics can have a serious performance impact.
• 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 artificial document (a document not present in the index) for which you want to retrieve term vectors.
• 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.
• Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.
  Hide per_field_analyzer attribute Show per_field_analyzer attribute object
  • *
    string Additional properties
• If true, the response includes:
  • The document count (how many documents contain this field).
  • The sum of document frequencies (the sum of document frequencies for all terms in this field).
  • The sum of total term frequencies (the sum of total term frequencies of each term in this field).
• 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:
  • The total term frequency (how often a term occurs in all documents).
  • The document frequency (the number of documents containing the current term).
    By default these values are not returned since term statistics can have a serious performance impact.
• Values are internal, external, external_gte, or force.

Responses

• 200 application/json
  Hide response attributes Show response 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 * attributes Show * attributes object