Skip to content

Bedrock  >  Operations  >  create_advanced_prompt_optimization_job

create_advanced_prompt_optimization_job

Operation

create_advanced_prompt_optimization_job async

create_advanced_prompt_optimization_job(input: CreateAdvancedPromptOptimizationJobInput, plugins: list[Plugin] | None = None) -> CreateAdvancedPromptOptimizationJobOutput

Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.

Parameters:

Name Type Description Default
input CreateAdvancedPromptOptimizationJobInput

An instance of CreateAdvancedPromptOptimizationJobInput.

required
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

Returns:

Type Description
CreateAdvancedPromptOptimizationJobOutput

An instance of CreateAdvancedPromptOptimizationJobOutput.

Input

CreateAdvancedPromptOptimizationJobInput dataclass

Create Advanced Prompt Optimization Job Request

Attributes

client_token class-attribute instance-attribute
client_token: str | None = None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.

encryption_key_arn class-attribute instance-attribute
encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data. If not specified, the output is encrypted with an Amazon-owned KMS key.

input_config class-attribute instance-attribute
input_config: AdvancedPromptOptimizationInputConfig | None = None

Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.

job_description class-attribute instance-attribute
job_description: str | None = None

A description of the advanced prompt optimization job.

job_name class-attribute instance-attribute
job_name: str | None = None

A name for the advanced prompt optimization job.

model_configurations class-attribute instance-attribute
model_configurations: list[ModelConfiguration] | None = None

A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

output_config class-attribute instance-attribute
output_config: AdvancedPromptOptimizationOutputConfig | None = None

Specifies the S3 location where optimization results will be stored.

tags class-attribute instance-attribute
tags: list[Tag] | None = None

Tags to associate with the advanced prompt optimization job.

Output

CreateAdvancedPromptOptimizationJobOutput dataclass

Create Advanced Prompt Optimization Job Response

Attributes

job_arn instance-attribute
job_arn: str

The Amazon Resource Name (ARN) of the created advanced prompt optimization job.