Package co.elastic.clients.elasticsearch.core

Class MtermvectorsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.MtermvectorsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MtermvectorsRequest extends RequestBase implements JsonpSerializable
Get multiple term vectors.

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.

See Also:

  • Field Details

  • Method Details

    • of

      public static MtermvectorsRequest of(Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)

    • docs

      public final List<MultiTermVectorsOperation> docs()
      An array of existing or artificial documents.

      API name: docs

    • fieldStatistics

      @Nullable public final Boolean fieldStatistics()
      If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

      API name: field_statistics

    • fields

      public final List<String> fields()
      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.

      API name: fields

    • ids

      public final List<String> ids()
      A simplified syntax to specify documents by their ID if they're in the same index.

      API name: ids

    • index

      @Nullable public final String index()
      The name of the index that contains the documents.

      API name: index

    • offsets

      @Nullable public final Boolean offsets()
      If true, the response includes term offsets.

      API name: offsets

    • payloads

      @Nullable public final Boolean payloads()
      If true, the response includes term payloads.

      API name: payloads

    • positions

      @Nullable public final Boolean positions()
      If true, the response includes term positions.

      API name: positions

    • preference

      @Nullable public final String preference()
      The node or shard the operation should be performed on. It is random by default.

      API name: preference

    • realtime

      @Nullable public final Boolean realtime()
      If true, the request is real-time as opposed to near-real-time.

      API name: realtime

    • routing

      @Nullable public final String routing()
      A custom value used to route operations to a specific shard.

      API name: routing

    • termStatistics

      @Nullable public final Boolean termStatistics()
      If true, the response includes term frequency and document frequency.

      API name: term_statistics

    • version

      @Nullable public final Long version()
      If true, returns the document version as part of a hit.

      API name: version

    • versionType

      @Nullable public final VersionType versionType()
      The version type.

      API name: version_type

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupMtermvectorsRequestDeserializer

      protected static void setupMtermvectorsRequestDeserializer(ObjectDeserializer<MtermvectorsRequest.Builder> op)