Skip to content

SearchQuickResponsesRequest

Source code in docs_src/capo_wisdom/types/search_quick_responses_request.py 
17
18
19
20
21
22
23
24
25
26
27
class SearchQuickResponsesRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_wisdom.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    search_expression: "capo_wisdom.types.quick_response_search_expression.QuickResponseSearchExpression"
    """<p>The search expression for querying the quick response.</p>"""
    next_token: NotRequired["capo_wisdom.types.non_empty_string.NonEmptyString"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""
    max_results: NotRequired["capo_wisdom.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per page.</p>"""
    attributes: NotRequired["capo_wisdom.types.contact_attributes.ContactAttributes"]
    """<p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p>"""

attributes instance-attribute 

attributes: NotRequired[ContactAttributes]

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

knowledge_base_id instance-attribute 

knowledge_base_id: UuidOrArn

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per page.

next_token instance-attribute 

next_token: NotRequired[NonEmptyString]

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

search_expression instance-attribute 

search_expression: QuickResponseSearchExpression

The search expression for querying the quick response.