Skip to content

Retriever

Source code in docs_src/capo_qbusiness/types/retriever.py 
15
16
17
18
19
20
21
22
23
24
25
class Retriever(TypedDict, closed=True):
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the Amazon Q Business application using the retriever.</p>"""
    retriever_id: NotRequired["capo_qbusiness.types.retriever_id.RetrieverId"]
    """<p>The identifier of the retriever used by your Amazon Q Business application.</p>"""
    type: NotRequired["capo_qbusiness.types.retriever_type.RetrieverType"]
    """<p>The type of your retriever.</p>"""
    status: NotRequired["capo_qbusiness.types.retriever_status.RetrieverStatus"]
    """<p>The status of your retriever.</p>"""
    display_name: NotRequired["capo_qbusiness.types.retriever_name.RetrieverName"]
    """<p>The name of your retriever.</p>"""

application_id instance-attribute 

application_id: NotRequired[ApplicationId]

The identifier of the Amazon Q Business application using the retriever.

display_name instance-attribute 

display_name: NotRequired[RetrieverName]

The name of your retriever.

retriever_id instance-attribute 

retriever_id: NotRequired[RetrieverId]

The identifier of the retriever used by your Amazon Q Business application.

status instance-attribute 

status: NotRequired[RetrieverStatus]

The status of your retriever.

type instance-attribute 

type: NotRequired[RetrieverType]

The type of your retriever.