Skip to content

RecommendationData

Source code in docs_src/capo_qconnect/types/recommendation_data.py
class RecommendationData(TypedDict, closed=True):
    recommendation_id: "capo_qconnect.types.recommendation_id.RecommendationId"
    """<p>The identifier of the recommendation.</p>"""
    document: NotRequired["capo_qconnect.types.document.Document"]
    """<p>The recommended document.</p>"""
    relevance_score: "capo_qconnect.types.relevance_score.RelevanceScore"
    """<p>The relevance score of the recommendation.</p>"""
    relevance_level: NotRequired["capo_qconnect.types.relevance_level.RelevanceLevel"]
    """<p>The relevance level of the recommendation.</p>"""
    type: NotRequired["capo_qconnect.types.recommendation_type.RecommendationType"]
    """<p>The type of recommendation.</p>"""
    data: NotRequired["capo_qconnect.types.data_summary.DataSummary"]
    """<p> Summary of the recommended content.</p>"""

data instance-attribute

data: NotRequired[DataSummary]

Summary of the recommended content.

document instance-attribute

document: NotRequired[Document]

The recommended document.

recommendation_id instance-attribute

recommendation_id: RecommendationId

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.