update_retriever¶
Operation¶
update_retriever
¶
update_retriever(request: UpdateRetrieverInput | UpdateRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRetrieverInputDict]) -> UpdateRetrieverOutput
Updates the retriever used for your Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateRetrieverInput | UpdateRetrieverInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateRetrieverInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateRetrieverOutput
|
An instance of |
update_retriever
async
¶
update_retriever(request: UpdateRetrieverInput | UpdateRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRetrieverInputDict]) -> UpdateRetrieverOutput
Updates the retriever used for your Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateRetrieverInput | UpdateRetrieverInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateRetrieverInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateRetrieverOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateRetrieverInputDict
¶
Bases: TypedDict
Dictionary form of UpdateRetrieverInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of your Amazon Q Business application.
configuration
instance-attribute
¶
configuration: RetrieverConfiguration | RetrieverConfigurationDict | None
Provides information on how the retriever used for your Amazon Q Business application is configured.
UpdateRetrieverInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateRetrieverInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of your Amazon Q Business application.
configuration
class-attribute
instance-attribute
¶
configuration: RetrieverConfiguration | None = ...
Provides information on how the retriever used for your Amazon Q Business application is configured.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
The name of your retriever.
Output¶
UpdateRetrieverOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateRetrieverOutput structure.