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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ConverseStreamRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Document`	`additionalModelRequestFields()`	Additional inference parameters that the model supports, beyond the base set of inference parameters that `ConverseStream` supports in the `inferenceConfig` field.
`List<String>`	`additionalModelResponseFieldPaths()`	Additional model parameters field paths to return in the response.
`static ConverseStreamRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GuardrailStreamConfiguration`	`guardrailConfig()`	Configuration information for a guardrail that you want to use in the request.
`boolean`	`hasAdditionalModelResponseFieldPaths()`	For responses, this returns true if the service returned a value for the AdditionalModelResponseFieldPaths property.
`int`	`hashCode()`
`boolean`	`hasMessages()`	For responses, this returns true if the service returned a value for the Messages property.
`boolean`	`hasSystem()`	For responses, this returns true if the service returned a value for the System property.
`InferenceConfiguration`	`inferenceConfig()`	Inference parameters to pass to the model.
`List<Message>`	`messages()`	The messages that you want to send to the model.
`String`	`modelId()`	The ID for the model.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ConverseStreamRequest.Builder>`	`serializableBuilderClass()`
`List<SystemContentBlock>`	`system()`	A system prompt to send to the model.
`ConverseStreamRequest.Builder`	`toBuilder()`
`ToolConfiguration`	`toolConfig()`	Configuration information for the tools that the model can use when generating a response.
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - modelId
```
public final String modelId()
```
    The ID for the model.
    
    The modelId to provide depends on the type of model that you use:
    
    If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
    
    If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
    
    If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
    Returns:
    
    The ID for the model.
    
    The modelId to provide depends on the type of model that you use:
    
    If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
    
    If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
    
    If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConverseStreamRequest.Builder,ConverseStreamRequest>
    
    Specified by:
    
    toBuilder in class BedrockRuntimeRequest
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ConverseStreamRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

modelId

hasMessages

messages

hasSystem

system

inferenceConfig

toolConfig

guardrailConfig

additionalModelRequestFields

hasAdditionalModelResponseFieldPaths

additionalModelResponseFieldPaths

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields