Skip to content

list_advanced_prompt_optimization_jobs

Operation

list_advanced_prompt_optimization_jobs

Lists the advanced prompt optimization jobs in your account.

Parameters:

Name Type Description Default
request ListAdvancedPromptOptimizationJobsInput | ListAdvancedPromptOptimizationJobsInputDict | 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[ListAdvancedPromptOptimizationJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAdvancedPromptOptimizationJobsOutput

An instance of ListAdvancedPromptOptimizationJobsOutput.

list_advanced_prompt_optimization_jobs async

Lists the advanced prompt optimization jobs in your account.

Parameters:

Name Type Description Default
request ListAdvancedPromptOptimizationJobsInput | ListAdvancedPromptOptimizationJobsInputDict | 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[ListAdvancedPromptOptimizationJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAdvancedPromptOptimizationJobsOutput

An instance of ListAdvancedPromptOptimizationJobsOutput.

Input

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

ListAdvancedPromptOptimizationJobsInputDict

Bases: TypedDict

Dictionary form of ListAdvancedPromptOptimizationJobsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response.

next_token instance-attribute
next_token: str | None

If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.

sort_by instance-attribute
sort_by: str | None

The field to sort the results by.

sort_order instance-attribute
sort_order: str | None

The sort order for the results.

ListAdvancedPromptOptimizationJobsInput dataclass

Bases: _SerdeShape

List Advanced Prompt Optimization Jobs Request

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in the response.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.

sort_by class-attribute instance-attribute
sort_by: str | None = ...

The field to sort the results by.

sort_order class-attribute instance-attribute
sort_order: str | None = ...

The sort order for the results.

Output

ListAdvancedPromptOptimizationJobsOutput dataclass

Bases: _SerdeShape

List Advanced Prompt Optimization Jobs Response

Attributes

job_summaries class-attribute instance-attribute
job_summaries: list[AdvancedPromptOptimizationJobSummary] | None = ...

A list of advanced prompt optimization job summaries.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.

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.