get_prompt_router¶
Operation¶
get_prompt_router
¶
get_prompt_router(request: GetPromptRouterInput | GetPromptRouterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPromptRouterInputDict]) -> GetPromptRouterOutput
Retrieves details about a prompt router.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetPromptRouterInput | GetPromptRouterInputDict | 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[GetPromptRouterInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetPromptRouterOutput
|
An instance of |
get_prompt_router
async
¶
get_prompt_router(request: GetPromptRouterInput | GetPromptRouterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPromptRouterInputDict]) -> GetPromptRouterOutput
Retrieves details about a prompt router.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetPromptRouterInput | GetPromptRouterInputDict | 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[GetPromptRouterInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetPromptRouterOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetPromptRouterOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetPromptRouterOutput structure.
Attributes¶
created_at
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
When the router was created.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The router's description.
fallback_model
instance-attribute
¶
fallback_model: PromptRouterTargetModel
The router's fallback model.
response_metadata
class-attribute
instance-attribute
¶
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.
routing_criteria
instance-attribute
¶
routing_criteria: RoutingCriteria
The router's routing criteria.