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

Class InvokeModelWithResponseStreamRequest

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.InvokeModelWithResponseStreamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class InvokeModelWithResponseStreamRequest extends BedrockRuntimeRequest implements ToCopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>

  • Method Details

    • body

      public final SdkBytes body()

      The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

      Returns:
      The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

    • contentType

      public final String contentType()

      The MIME type of the input data in the request. You must specify application/json.

      Returns:
      The MIME type of the input data in the request. You must specify application/json.

    • accept

      public final String accept()

      The desired MIME type of the inference body in the response. The default value is application/json.

      Returns:
      The desired MIME type of the inference body in the response. The default value is application/json.

    • modelId

      public final String modelId()

      The unique identifier of the model to invoke to run inference.

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

      Returns:
      The unique identifier of the model to invoke to run inference.

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

    • trace

      public final Trace trace()

      Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

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

      Returns:
      Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
      See Also:

    • traceAsString

      public final String traceAsString()

      Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

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

      Returns:
      Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
      See Also:

    • guardrailIdentifier

      public final String guardrailIdentifier()

      The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.

      An error is thrown in the following situations.

      • You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

      • You enable the guardrail but the contentType isn't application/json.

      • You provide a guardrail identifier, but guardrailVersion isn't specified.

      Returns:
      The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.

      An error is thrown in the following situations.

      • You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

      • You enable the guardrail but the contentType isn't application/json.

      • You provide a guardrail identifier, but guardrailVersion isn't specified.

    • guardrailVersion

      public final String guardrailVersion()

      The version number for the guardrail. The value can also be DRAFT.

      Returns:
      The version number for the guardrail. The value can also be DRAFT.

    • toBuilder

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

    • builder

      public static InvokeModelWithResponseStreamRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InvokeModelWithResponseStreamRequest.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.