_core.termvectors.yaml

openapi: 3.1.0
info:
  title: Schemas of _core.termvectors category
  description: Schemas of _core.termvectors category
  version: 1.0.0
paths: {}
components:
  schemas:
    Filter:
      type: object
      properties:
        max_doc_freq:
          description: |-
            Ignore words which occur in more than this many docs.
            Defaults to unbounded.
          type: number
        max_num_terms:
          description: Maximum number of terms that must be returned per field.
          type: number
        max_term_freq:
          description: |-
            Ignore words with more than this frequency in the source doc.
            Defaults to unbounded.
          type: number
        max_word_length:
          description: |-
            The maximum word length above which words will be ignored.
            Defaults to unbounded.
          type: number
        min_doc_freq:
          description: Ignore terms which do not occur in at least this many docs.
          type: number
        min_term_freq:
          description: Ignore words with less than this frequency in the source doc.
          type: number
        min_word_length:
          description: The minimum word length below which words will be ignored.
          type: number
    TermVector:
      type: object
      properties:
        field_statistics:
          $ref: '#/components/schemas/FieldStatistics'
        terms:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Term'
      required:
        - field_statistics
        - terms
    FieldStatistics:
      type: object
      properties:
        doc_count:
          type: number
        sum_doc_freq:
          type: number
        sum_ttf:
          type: number
      required:
        - doc_count
        - sum_doc_freq
        - sum_ttf
    Term:
      type: object
      properties:
        doc_freq:
          type: number
        score:
          type: number
        term_freq:
          type: number
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/Token'
        ttf:
          type: number
      required:
        - term_freq
    Token:
      type: object
      properties:
        end_offset:
          type: number
        payload:
          type: string
        position:
          type: number
        start_offset:
          type: number
      required:
        - position