Module: Turbopuffer::Models::HighlightFragmentBy

Extended by:

Internal::Type::Enum

Defined in:

lib/turbopuffer/models/highlight_fragment_by.rb,
sig/turbopuffer/models/highlight_fragment_by.rbs

Overview

How to split a text attribute into fragments for highlighting.

Constant Summary

NONE =

Treat the whole attribute as a single fragment.

Returns:

• (:none)

:none

SENTENCE =

Split the attribute into sentences. This is the default.

Returns:

• (:sentence)

:sentence

PARAGRAPH =

Split the attribute into paragraphs.

Returns:

• (:paragraph)

:paragraph

WORD =

Split the attribute into individual words.

Returns:

• (:word)

:word

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #self?.values ⇒ ::Array[Turbopuffer::Models::highlight_fragment_by]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/turbopuffer/models/highlight_fragment_by.rb', line 21

Instance Method Details

#self?.values ⇒ ::Array[Turbopuffer::Models::highlight_fragment_by]

Returns:

• (::Array[Turbopuffer::Models::highlight_fragment_by])

# File 'sig/turbopuffer/models/highlight_fragment_by.rbs', line 20

def self?.values: -> ::Array[Turbopuffer::Models::highlight_fragment_by]