Package software.amazon.awssdk.services.bedrockagentruntime.model

Class FunctionResult

    • Method Detail

      • actionGroup

        public final String actionGroup()

        The action group that the function belongs to.

        Returns:
        The action group that the function belongs to.

      • agentId

        public final String agentId()

        The agent's ID.

        Returns:
        The agent's ID.

      • confirmationState

        public final ConfirmationState confirmationState()

        Contains the user confirmation information about the function that was called.

        If the service returns an enum value that is not available in the current SDK version, confirmationState will return ConfirmationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confirmationStateAsString().

        Returns:
        Contains the user confirmation information about the function that was called.
        See Also:
        ConfirmationState

      • confirmationStateAsString

        public final String confirmationStateAsString()

        Contains the user confirmation information about the function that was called.

        If the service returns an enum value that is not available in the current SDK version, confirmationState will return ConfirmationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confirmationStateAsString().

        Returns:
        Contains the user confirmation information about the function that was called.
        See Also:
        ConfirmationState

      • function

        public final String function()

        The name of the function that was called.

        Returns:
        The name of the function that was called.

      • hasResponseBody

        public final boolean hasResponseBody()
        For responses, this returns true if the service returned a value for the ResponseBody property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • responseBody

        public final Map<String,​ContentBody> responseBody()

        The response from the function call using the parameters. 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResponseBody() method.

        Returns:
        The response from the function call using the parameters. 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.

      • responseState

        public final 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

        If the service returns an enum value that is not available in the current SDK version, responseState will return ResponseState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseStateAsString().

        Returns:
        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
        See Also:
        ResponseState

      • responseStateAsString

        public final String responseStateAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, responseState will return ResponseState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseStateAsString().

        Returns:
        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
        See Also:
        ResponseState

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)