Package software.amazon.awssdk.services.bedrockruntime.model

Class ConverseStreamRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest
software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ConverseStreamRequest.Builder,ConverseStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class ConverseStreamRequest extends BedrockRuntimeRequest implements ToCopyableBuilder<ConverseStreamRequest.Builder,ConverseStreamRequest>

  • Method Details

    • modelId

      public final String modelId()

      The ID for the model.

      The modelId to provide depends on the type of model that you use:

      Returns:
      The ID for the model.

      The modelId to provide depends on the type of model that you use:

    • hasMessages

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

    • messages

      public final List<Message> messages()

      The messages that you want to send to the model.

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

      Returns:
      The messages that you want to send to the model.

    • hasSystem

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

    • system

      public final List<SystemContentBlock> system()

      A system prompt to send to the model.

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

      Returns:
      A system prompt to send to the model.

    • inferenceConfig

      public final InferenceConfiguration inferenceConfig()

      Inference parameters to pass to the model. ConverseStream supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

      Returns:
      Inference parameters to pass to the model. ConverseStream supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

    • toolConfig

      public final ToolConfiguration toolConfig()

      Configuration information for the tools that the model can use when generating a response.

      This field is only supported by Anthropic Claude 3 models.

      Returns:
      Configuration information for the tools that the model can use when generating a response.

      This field is only supported by Anthropic Claude 3 models.

    • guardrailConfig

      public final GuardrailStreamConfiguration guardrailConfig()

      Configuration information for a guardrail that you want to use in the request.

      Returns:
      Configuration information for a guardrail that you want to use in the request.

    • additionalModelRequestFields

      public final Document additionalModelRequestFields()

      Additional inference parameters that the model supports, beyond the base set of inference parameters that ConverseStream supports in the inferenceConfig field.

      Returns:
      Additional inference parameters that the model supports, beyond the base set of inference parameters that ConverseStream supports in the inferenceConfig field.

    • hasAdditionalModelResponseFieldPaths

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

    • additionalModelResponseFieldPaths

      public final List<String> additionalModelResponseFieldPaths()

      Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

      [ "/stop_sequence" ]

      For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

      ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.

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

      Returns:
      Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

      [ "/stop_sequence" ]

      For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

      ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.

    • toBuilder

      public ConverseStreamRequest.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<ConverseStreamRequest.Builder,ConverseStreamRequest>
      Specified by:
      toBuilder in class BedrockRuntimeRequest
      Returns:
      a builder for type T

    • builder

      public static ConverseStreamRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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