start_bot_resource_generation `async` ¶

start_bot_resource_generation(
    generation_input_prompt: GenerationInput,
    bot_id: Id,
    bot_version: BotVersion,
    locale_id: LocaleId,
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
) -> StartBotResourceGenerationResponse

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Parameters:

generation_input_prompt (GenerationInput) –

The prompt to generate intents and slot types for the bot locale. Your description should be both detailed and precise to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.
bot_id (Id) –

The unique identifier of the bot for which to generate intents and slot types.
bot_version (BotVersion) –

The version of the bot for which to generate intents and slot types.
locale_id (LocaleId) –

The locale of the bot for which to generate intents and slot types.

Raises:

ConflictException –

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
InternalServerException –

The service encountered an unexpected condition. Try your request again.
PreconditionFailedException –

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
ServiceQuotaExceededException –

You have reached a quota for your bot.
ThrottlingException –

Your request rate is too high. Reduce the frequency of requests.
ValidationException –

One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lex_models_v2/_services/async_lex_models_v2.py

async def start_bot_resource_generation(
    self,
    generation_input_prompt: "capo_lex_models_v2.types.generation_input.GenerationInput",
    bot_id: "capo_lex_models_v2.types.id.Id",
    bot_version: "capo_lex_models_v2.types.bot_version.BotVersion",
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId",
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
) -> "capo_lex_models_v2.types.start_bot_resource_generation_response.StartBotResourceGenerationResponse":
    """<p>Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the <code>DescribeBotResourceGeneration</code> operation to check on the status of the generation and for the <code>generatedBotLocaleUrl</code> when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.</p>

    Args:
        generation_input_prompt: <p>The prompt to generate intents and slot types for the bot locale. Your description should be both <i>detailed</i> and <i>precise</i> to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.</p>
        bot_id: <p>The unique identifier of the bot for which to generate intents and slot types.</p>
        bot_version: <p>The version of the bot for which to generate intents and slot types.</p>
        locale_id: <p>The locale of the bot for which to generate intents and slot types.</p>

    Raises:
        capo_lex_models_v2.errors.conflict_exception.ConflictException: <p>The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again. </p>
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.precondition_failed_exception.PreconditionFailedException: <p>Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.</p>
        capo_lex_models_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lex_models_v2.types.start_bot_resource_generation_request.StartBotResourceGenerationRequest]",
    ) -> AsyncOperationResponse[
        "capo_lex_models_v2.types.start_bot_resource_generation_response.StartBotResourceGenerationResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.start_bot_resource_generation

        (
            output,
            http_response,
        ) = await capo_lex_models_v2._operations.lex_model_building_service_v2.start_bot_resource_generation.async_start_bot_resource_generation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartBotResourceGeneration")
    )
    input_: capo_lex_models_v2.types.start_bot_resource_generation_request.StartBotResourceGenerationRequest = {
        "generation_input_prompt": generation_input_prompt,
        "bot_id": bot_id,
        "bot_version": bot_version,
        "locale_id": locale_id,
    }

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

start_bot_resource_generation async ¶

start_bot_resource_generation `async` ¶