Skip to content

put_feedback

Operation

put_feedback

put_feedback(request: PutFeedbackInput | PutFeedbackInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutFeedbackInputDict]) -> PutFeedbackOutput

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

Parameters:

Name Type Description Default
request PutFeedbackInput | PutFeedbackInputDict | 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[PutFeedbackInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutFeedbackOutput

An instance of PutFeedbackOutput.

put_feedback async

put_feedback(request: PutFeedbackInput | PutFeedbackInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutFeedbackInputDict]) -> PutFeedbackOutput

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

Parameters:

Name Type Description Default
request PutFeedbackInput | PutFeedbackInputDict | 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[PutFeedbackInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutFeedbackOutput

An instance of PutFeedbackOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

PutFeedbackInputDict

Bases: TypedDict

Dictionary form of PutFeedbackInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the application associated with the feedback.

conversation_id instance-attribute
conversation_id: Required[str]

The identifier of the conversation the feedback is attached to.

message_copied_at instance-attribute
message_copied_at: datetime | None

The timestamp for when the feedback was recorded.

message_id instance-attribute
message_id: Required[str]

The identifier of the chat message that the feedback was given for.

message_usefulness instance-attribute

The feedback usefulness value given by the user to the chat message.

user_id instance-attribute
user_id: str | None

The identifier of the user giving the feedback.

PutFeedbackInput dataclass

Bases: _SerdeShape

Dataclass for PutFeedbackInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the application associated with the feedback.

conversation_id class-attribute instance-attribute
conversation_id: str | None = ...

The identifier of the conversation the feedback is attached to.

message_copied_at class-attribute instance-attribute
message_copied_at: datetime | None = ...

The timestamp for when the feedback was recorded.

message_id class-attribute instance-attribute
message_id: str | None = ...

The identifier of the chat message that the feedback was given for.

message_usefulness class-attribute instance-attribute
message_usefulness: MessageUsefulnessFeedback | None = ...

The feedback usefulness value given by the user to the chat message.

user_id class-attribute instance-attribute
user_id: str | None = ...

The identifier of the user giving the feedback.

Output

PutFeedbackOutput dataclass

Bases: _SerdeShape

Dataclass for PutFeedbackOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.