Skip to content

QQueryCardInput

Source code in docs_src/capo_qapps/types/q_query_card_input.py
class QQueryCardInput(TypedDict, closed=True):
    title: "capo_qapps.types.title.Title"
    """<p>The title or label of the query card.</p>"""
    id: "capo_qapps.types.uuid.UUID"
    """<p>The unique identifier of the query card.</p>"""
    type: "capo_qapps.types.card_type.CardType"
    """<p>The type of the card.</p>"""
    prompt: "capo_qapps.types.prompt.Prompt"
    """<p>The prompt or instructions displayed for the query card.</p>"""
    output_source: "capo_qapps.types.card_output_source.CardOutputSource"
    """<p>The source or type of output to generate for the query card.</p>"""
    attribute_filter: NotRequired["capo_qapps.types.attribute_filter.AttributeFilter"]
    """<p>Turns on filtering of responses based on document attributes or metadata fields.</p>"""

attribute_filter instance-attribute

attribute_filter: NotRequired[AttributeFilter]

Turns on filtering of responses based on document attributes or metadata fields.

id instance-attribute

id: UUID

The unique identifier of the query card.

output_source instance-attribute

output_source: CardOutputSource

The source or type of output to generate for the query card.

prompt instance-attribute

prompt: Prompt

The prompt or instructions displayed for the query card.

title instance-attribute

title: Title

The title or label of the query card.

type instance-attribute

type: CardType

The type of the card.