ApiResultDict¶
Dictionary Type¶
ApiResultDict
¶
Bases: TypedDict
Dictionary form of ApiResult.
Attributes¶
action_group
instance-attribute
¶
The action group that the API operation belongs to.
confirmation_state
instance-attribute
¶
confirmation_state: str | None
Controls the API operations or functions to invoke based on the user confirmation.
http_status_code
instance-attribute
¶
http_status_code: int | None
http status code from API execution response (for example: 200, 400, 500).
response_body
instance-attribute
¶
response_body: Mapping[str, ContentBody | ContentBodyDict] | None
The response body from the API operation. The key of the object is the
content type (currently, only TEXT is supported). The response may be
returned directly or from the Lambda function.
response_state
instance-attribute
¶
response_state: str | None
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt