Qbusiness  >  Structures  >  Retriever

Retriever

Structure Class

Retriever dataclass

Summary information for the retriever used for your Amazon Q Business application.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

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

display_name class-attribute instance-attribute

display_name: str | None = None

The name of your retriever.

retriever_id class-attribute instance-attribute

retriever_id: str | None = None

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

status class-attribute instance-attribute

status: RetrieverStatus | None = None

The status of your retriever.

type class-attribute instance-attribute

type: RetrieverType | None = None

The type of your retriever.