Skip to content

batch_delete_advanced_prompt_optimization_job

Operation

batch_delete_advanced_prompt_optimization_job

Deletes one or more advanced prompt optimization jobs.

Parameters:

Name Type Description Default
request BatchDeleteAdvancedPromptOptimizationJobInput | BatchDeleteAdvancedPromptOptimizationJobInputDict | 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[BatchDeleteAdvancedPromptOptimizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
BatchDeleteAdvancedPromptOptimizationJobOutput

An instance of BatchDeleteAdvancedPromptOptimizationJobOutput.

batch_delete_advanced_prompt_optimization_job async

Deletes one or more advanced prompt optimization jobs.

Parameters:

Name Type Description Default
request BatchDeleteAdvancedPromptOptimizationJobInput | BatchDeleteAdvancedPromptOptimizationJobInputDict | 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[BatchDeleteAdvancedPromptOptimizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
BatchDeleteAdvancedPromptOptimizationJobOutput

An instance of BatchDeleteAdvancedPromptOptimizationJobOutput.

Input

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

BatchDeleteAdvancedPromptOptimizationJobInputDict

Bases: TypedDict

Dictionary form of BatchDeleteAdvancedPromptOptimizationJobInput.

Attributes

job_identifiers instance-attribute
job_identifiers: Required[Sequence[str]]

A list of advanced prompt optimization job identifiers (ARNs or IDs) to delete.

BatchDeleteAdvancedPromptOptimizationJobInput dataclass

Bases: _SerdeShape

Batch Delete Advanced Prompt Optimization Jobs Request

Attributes

job_identifiers class-attribute instance-attribute
job_identifiers: list[str] | None = ...

A list of advanced prompt optimization job identifiers (ARNs or IDs) to delete.

Output

BatchDeleteAdvancedPromptOptimizationJobOutput dataclass

Bases: _SerdeShape

Batch Delete Advanced Prompt Optimization Jobs Response

Attributes

advanced_prompt_optimization_jobs instance-attribute
advanced_prompt_optimization_jobs: list[BatchDeleteAdvancedPromptOptimizationJobItem]

A list of successfully deleted advanced prompt optimization jobs.

errors instance-attribute

A list of errors encountered during batch deletion.

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.