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. 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:

  • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CodeInterpreterResult.Builder,CodeInterpreterResult>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<CodeInterpreterResult.Builder,CodeInterpreterResult>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.

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