Skip to content

TextOptions

Source code in docs_src/capo_cloudsearch/types/text_options.py 
16
17
18
19
20
21
22
23
24
25
26
27
class TextOptions(TypedDict, closed=True):
    default_value: NotRequired["capo_cloudsearch.types.field_value.FieldValue"]
    """A value to use for the field if the field isn't specified for a document."""
    source_field: NotRequired["capo_cloudsearch.types.field_name.FieldName"]
    return_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether the contents of the field can be returned in the search results.</p>"""
    sort_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether the field can be used to sort the search results.</p>"""
    highlight_enabled: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>Whether highlights can be returned for the field.</p>"""
    analysis_scheme: NotRequired["capo_cloudsearch.types.word.Word"]
    """<p>The name of an analysis scheme for a <code>text</code> field.</p>"""

analysis_scheme instance-attribute 

analysis_scheme: NotRequired[Word]

The name of an analysis scheme for a text field.

default_value instance-attribute 

default_value: NotRequired[FieldValue]

A value to use for the field if the field isn't specified for a document.

highlight_enabled instance-attribute 

highlight_enabled: NotRequired[Boolean]

Whether highlights can be returned for the field.

return_enabled instance-attribute 

return_enabled: NotRequired[Boolean]

Whether the contents of the field can be returned in the search results.

sort_enabled instance-attribute 

sort_enabled: NotRequired[Boolean]

Whether the field can be used to sort the search results.

source_field instance-attribute 

source_field: NotRequired[FieldName]