github.com/weaviate/weaviate@v1.24.6/modules/text-spellcheck/additional/models/models.go (about)

     1  //                           _       _
     2  // __      _____  __ ___   ___  __ _| |_ ___
     3  // \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
     4  //  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
     5  //   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
     6  //
     7  //  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
     8  //
     9  //  CONTACT: hello@weaviate.io
    10  //
    11  
    12  package models
    13  
    14  // SpellCheckChange describes the misspellings
    15  type SpellCheckChange struct {
    16  	Original  string `json:"original,omitempty"`
    17  	Corrected string `json:"corrected,omitempty"`
    18  }
    19  
    20  // SpellCheck presents proper text without misspellings
    21  // and the list of words that were misspelled
    22  type SpellCheck struct {
    23  	OriginalText        string             `json:"originalText,omitempty"`
    24  	DidYouMean          string             `json:"didYouMean,omitempty"`
    25  	Location            string             `json:"location,omitempty"`
    26  	NumberOfCorrections int                `json:"numberOfCorrections,omitempty"`
    27  	Changes             []SpellCheckChange `json:"changes,omitempty"`
    28  }