Skip to content

list_prompt_routers

Operation

list_prompt_routers

list_prompt_routers(request: ListPromptRoutersInput | ListPromptRoutersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPromptRoutersInputDict]) -> ListPromptRoutersOutput

Retrieves a list of prompt routers.

Parameters:

Name Type Description Default
request ListPromptRoutersInput | ListPromptRoutersInputDict | 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[ListPromptRoutersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPromptRoutersOutput

An instance of ListPromptRoutersOutput.

list_prompt_routers async

list_prompt_routers(request: ListPromptRoutersInput | ListPromptRoutersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPromptRoutersInputDict]) -> ListPromptRoutersOutput

Retrieves a list of prompt routers.

Parameters:

Name Type Description Default
request ListPromptRoutersInput | ListPromptRoutersInputDict | 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[ListPromptRoutersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPromptRoutersOutput

An instance of ListPromptRoutersOutput.

Input

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

ListPromptRoutersInputDict

Bases: TypedDict

Dictionary form of ListPromptRoutersInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of prompt routers to return in one page of results.

next_token instance-attribute
next_token: str | None

Specify the pagination token from a previous request to retrieve the next page of results.

type instance-attribute
type: str | None

The type of the prompt routers, such as whether it's default or custom.

ListPromptRoutersInput dataclass

Bases: _SerdeShape

Dataclass for ListPromptRoutersInput structure.

Attributes

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

The maximum number of prompt routers to return in one page of results.

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

Specify the pagination token from a previous request to retrieve the next page of results.

type class-attribute instance-attribute
type: str = ...

The type of the prompt routers, such as whether it's default or custom.

Output

ListPromptRoutersOutput dataclass

Bases: _SerdeShape

Dataclass for ListPromptRoutersOutput structure.

Attributes

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

Specify the pagination token from a previous request to retrieve the next page of results.

prompt_router_summaries class-attribute instance-attribute
prompt_router_summaries: list[PromptRouterSummary] | None = ...

A list of prompt router summaries.

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.