Skip to content

RecommendationData

Source code in docs_src/capo_wisdom/types/recommendation_data.py 
16
17
18
19
20
21
22
23
24
25
26
class RecommendationData(TypedDict, closed=True):
    recommendation_id: "str"
    """<p>The identifier of the recommendation.</p>"""
    document: "capo_wisdom.types.document.Document"
    """<p>The recommended document.</p>"""
    relevance_score: "capo_wisdom.types.relevance_score.RelevanceScore"
    """<p>The relevance score of the recommendation.</p>"""
    relevance_level: NotRequired["capo_wisdom.types.relevance_level.RelevanceLevel"]
    """<p>The relevance level of the recommendation.</p>"""
    type: NotRequired["capo_wisdom.types.recommendation_type.RecommendationType"]
    """<p>The type of recommendation.</p>"""

document instance-attribute 

document: Document

The recommended document.

recommendation_id instance-attribute 

recommendation_id: str

The identifier of the recommendation.

relevance_level instance-attribute 

relevance_level: NotRequired[RelevanceLevel]

The relevance level of the recommendation.

relevance_score instance-attribute 

relevance_score: RelevanceScore

The relevance score of the recommendation.

type instance-attribute 

type: NotRequired[RecommendationType]

The type of recommendation.