create_retriever¶
Operation¶
async
¶
create_retriever(input: CreateRetrieverInput, plugins: list[Plugin] | None = None) -> CreateRetrieverOutput
Adds a retriever to your Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateRetrieverInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateRetrieverOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateRetrieverInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of your Amazon Q Business application.
class-attribute
instance-attribute
¶
client_token: str | None = None
A token that you provide to identify the request to create your Amazon Q Business application retriever.
class-attribute
instance-attribute
¶
configuration: RetrieverConfiguration | None = None
Provides information on how the retriever used for your Amazon Q Business application is configured.
class-attribute
instance-attribute
¶
display_name: str | None = None
The name of your retriever.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = None
A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
class-attribute
instance-attribute
¶
type: RetrieverType | None = None
The type of retriever you are using.
Output¶
dataclass
¶
Dataclass for CreateRetrieverOutput structure.