Class ConverseStreamRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ConverseStreamRequest.Builder,
ConverseStreamRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Document
Additional inference parameters that the model supports, beyond the base set of inference parameters thatConverse
andConverseStream
support in theinferenceConfig
field.Additional model parameters field paths to return in the response.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.Configuration information for a guardrail that you want to use in the request.final boolean
For responses, this returns true if the service returned a value for the AdditionalModelResponseFieldPaths property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Messages property.final boolean
For responses, this returns true if the service returned a value for the PromptVariables property.final boolean
For responses, this returns true if the service returned a value for the RequestMetadata property.final boolean
For responses, this returns true if the service returned a value for the System property.final InferenceConfiguration
Inference parameters to pass to the model.messages()
The messages that you want to send to the model.final String
modelId()
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference.final PerformanceConfiguration
Model performance settings for the request.final Map
<String, PromptVariableValues> Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation.Key-value pairs that you can use to filter invocation logs.static Class
<? extends ConverseStreamRequest.Builder> final List
<SystemContentBlock> system()
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.Take this object and create a builder that contains all of the current property values of this object.final ToolConfiguration
Configuration information for the tools that the model can use when generating a response.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
modelId
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource 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 an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference 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.
-
To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.
The Converse API doesn't support imported models.
- Returns:
- Specifies the model or throughput with which to run inference, or the prompt resource to use in
inference. The value depends on the resource 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 an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference 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.
-
To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.
The Converse API doesn't support imported models.
-
-
-
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 theisEmpty()
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
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 theisEmpty()
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
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
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 prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
-
inferenceConfig
Inference parameters to pass to the model.
Converse
andConverseStream
support a base set of inference parameters. If you need to pass additional parameters that the model supports, use theadditionalModelRequestFields
request field.- Returns:
- Inference parameters to pass to the model.
Converse
andConverseStream
support a base set of inference parameters. If you need to pass additional parameters that the model supports, use theadditionalModelRequestFields
request field.
-
toolConfig
Configuration information for the tools that the model can use when generating a response.
For information about models that support streaming tool use, see Supported models and model features.
- Returns:
- Configuration information for the tools that the model can use when generating a response.
For information about models that support streaming tool use, see Supported models and model features.
-
guardrailConfig
Configuration information for a guardrail that you want to use in the request. If you include
guardContent
blocks in thecontent
field in themessages
field, the guardrail operates only on those messages. If you include noguardContent
blocks, the guardrail operates on all messages in the request body and in any included prompt resource.- Returns:
- Configuration information for a guardrail that you want to use in the request. If you include
guardContent
blocks in thecontent
field in themessages
field, the guardrail operates only on those messages. If you include noguardContent
blocks, the guardrail operates on all messages in the request body and in any included prompt resource.
-
additionalModelRequestFields
Additional inference parameters that the model supports, beyond the base set of inference parameters that
Converse
andConverseStream
support in theinferenceConfig
field. For more information, see Model parameters.- Returns:
- Additional inference parameters that the model supports, beyond the base set of inference parameters that
Converse
andConverseStream
support in theinferenceConfig
field. For more information, see Model parameters.
-
hasPromptVariables
public final boolean hasPromptVariables()For responses, this returns true if the service returned a value for the PromptVariables property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
promptVariables
Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the
modelId
field.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
hasPromptVariables()
method.- Returns:
- Contains a map of variables in a prompt from Prompt management to objects containing the values to fill
in for them when running model invocation. This field is ignored if you don't specify a prompt resource
in the
modelId
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 theisEmpty()
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
Additional model parameters field paths to return in the response.
Converse
andConverseStream
return the requested fields as a JSON Pointer object in theadditionalModelResponseFields
field. The following is example JSON foradditionalModelResponseFieldPaths
.[ "/stop_sequence" ]
For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.
Converse
andConverseStream
reject an empty JSON Pointer or incorrectly structured JSON Pointer with a400
error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored byConverse
.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.
Converse
andConverseStream
return the requested fields as a JSON Pointer object in theadditionalModelResponseFields
field. The following is example JSON foradditionalModelResponseFieldPaths
.[ "/stop_sequence" ]
For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.
Converse
andConverseStream
reject an empty JSON Pointer or incorrectly structured JSON Pointer with a400
error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored byConverse
.
-
hasRequestMetadata
public final boolean hasRequestMetadata()For responses, this returns true if the service returned a value for the RequestMetadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
requestMetadata
Key-value pairs that you can use to filter invocation logs.
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
hasRequestMetadata()
method.- Returns:
- Key-value pairs that you can use to filter invocation logs.
-
performanceConfig
Model performance settings for the request.
- Returns:
- Model performance settings for the request.
-
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 interfaceToCopyableBuilder<ConverseStreamRequest.Builder,
ConverseStreamRequest> - Specified by:
toBuilder
in classBedrockRuntimeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-