Skip to content

Suggestion

Source code in docs_src/capo_kendra/types/suggestion.py 
13
14
15
16
17
18
19
class Suggestion(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.result_id.ResultId"]
    """<p>The UUID (universally unique identifier) of a single query suggestion.</p>"""
    value: NotRequired["capo_kendra.types.suggestion_value.SuggestionValue"]
    """<p>The value for the UUID (universally unique identifier) of a single query suggestion.</p> <p>The value is the text string of a suggestion.</p>"""
    source_documents: NotRequired["capo_kendra.types.source_documents.SourceDocuments"]
    """<p>The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.</p>"""

id instance-attribute 

id: NotRequired[ResultId]

The UUID (universally unique identifier) of a single query suggestion.

source_documents instance-attribute 

source_documents: NotRequired[SourceDocuments]

The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.

value instance-attribute 

value: NotRequired[SuggestionValue]

The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.