Skip to content

get_quick_response async

get_quick_response(
    quick_response_id: UuidOrArn,
    knowledge_base_id: UuidOrArn,
    *,
    config_overrides: Optional[AsyncQConnectClientConfig] = None,
) -> GetQuickResponseResponse

Retrieves the quick response.

Parameters:

  • quick_response_id (UuidOrArn) –

    The identifier of the quick response.

  • knowledge_base_id (UuidOrArn) –

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

Raises:

Source code in docs_src/capo_qconnect/_services/async_q_connect.py
async def get_quick_response(
    self,
    quick_response_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn",
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn",
    *,
    config_overrides: Optional[AsyncQConnectClientConfig] = None,
) -> "capo_qconnect.types.get_quick_response_response.GetQuickResponseResponse":
    """<p>Retrieves the quick response.</p>

    Args:
        quick_response_id: <p>The identifier of the quick response.</p>
        knowledge_base_id: <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>

    Raises:
        capo_qconnect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_qconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_qconnect.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_qconnect.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by a service.</p>
        capo_qconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qconnect.types.get_quick_response_request.GetQuickResponseRequest]",
    ) -> AsyncOperationResponse[
        "capo_qconnect.types.get_quick_response_response.GetQuickResponseResponse"
    ]:
        import capo_qconnect._operations.wisdom_service.get_quick_response

        (
            output,
            http_response,
        ) = await capo_qconnect._operations.wisdom_service.get_quick_response.async_get_quick_response(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_qconnect.types.get_quick_response_response.GetQuickResponseResponse",
    ) -> dict[str, Any]:
        import capo_qconnect.types.get_quick_response_response

        return capo_qconnect.types.get_quick_response_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetQuickResponse", redact_output=_redact_output),
    )
    input_: capo_qconnect.types.get_quick_response_request.GetQuickResponseRequest = {
        "quick_response_id": quick_response_id,
        "knowledge_base_id": knowledge_base_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output