Package software.amazon.awssdk.services.bedrockagentcore.model

Class CodeInterpreterResult

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.CodeInterpreterResult
All Implemented Interfaces:
Serializable, SdkPojo, CodeInterpreterStreamOutput, ToCopyableBuilder<CodeInterpreterResult.Builder,CodeInterpreterResult>
Direct Known Subclasses:
DefaultResult
@Generated("software.amazon.awssdk:codegen") public class CodeInterpreterResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodeInterpreterResult.Builder,CodeInterpreterResult>, CodeInterpreterStreamOutput

The output produced by executing code in a code interpreter session in Amazon Bedrock AgentCore. This structure contains the results of code execution, including textual output, structured data, and error information. Agents use these results to generate responses that incorporate computation, data analysis, and visualization.

See Also:

  • Constructor Details

  • Method Details

    • hasContent

      public final boolean hasContent()
      For responses, this returns true if the service returned a value for the Content 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.

    • content

      public final List<ContentBlock> content()

      The textual content of the execution result. This includes standard output from the code execution, such as print statements, console output, and text representations of results.

      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 hasContent() method.

      Returns:
      The textual content of the execution result. This includes standard output from the code execution, such as print statements, console output, and text representations of results.

    • structuredContent

      public final ToolResultStructuredContent structuredContent()

      The structured content of the execution result. This includes additional metadata about the execution, such as execution time, memory usage, and structured representations of output data. The format depends on the specific code interpreter and execution context.

      Returns:
      The structured content of the execution result. This includes additional metadata about the execution, such as execution time, memory usage, and structured representations of output data. The format depends on the specific code interpreter and execution context.

    • isError

      public final Boolean isError()

      Indicates whether the result represents an error. If true, the content contains error messages or exception information. If false, the content contains successful execution results.

      Returns:
      Indicates whether the result represents an error. If true, the content contains error messages or exception information. If false, the content contains successful execution results.

    • toBuilder

      public CodeInterpreterResult.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CodeInterpreterResult.Builder,CodeInterpreterResult>

    • builder

      public static CodeInterpreterResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CodeInterpreterResult.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)

    • copy

      public final CodeInterpreterResult copy(Consumer<? super CodeInterpreterResult.Builder> modifier)
      Specified by:
      copy in interface ToCopyableBuilder<CodeInterpreterResult.Builder,CodeInterpreterResult>

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo

    • accept

      public void accept(InvokeCodeInterpreterResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of CodeInterpreterResult.
      Specified by:
      accept in interface CodeInterpreterStreamOutput
      Parameters:
      visitor - Visitor to invoke.