bedrockagentruntime/aws.sdk.kotlin.services.bedrockagentruntime.model/ApiResult

ApiResult

class ApiResult

Contains information about the API operation that was called from the action group and the response body that was returned.

This data type is used in the following API operations:

In the returnControlInvocationResults of the InvokeAgent request

Types

object Companion

Properties

val actionGroup: String

The action group that the API operation belongs to.

val agentId: String?

The agent's ID.

val apiPath: String?

The path to the API operation.

confirmationState

val confirmationState: ConfirmationState?

Controls the API operations or functions to invoke based on the user confirmation.

val httpMethod: String?

The HTTP method for the API operation.

val httpStatusCode: Int?

http status code from API execution response (for example: 200, 400, 500).

val responseBody: Map<String, ContentBody>?

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.

val responseState: ResponseState?

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

Functions

inline fun copy(block: ApiResult.Builder.() -> Unit = {}): ApiResult

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String