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

Class ConverseStreamRequest

    • Method Detail

      • modelId

        public final String 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:

        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:

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

        public final InferenceConfiguration inferenceConfig()

        Inference parameters to pass to the model. Converse and ConverseStream support 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. Converse and ConverseStream support 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.

        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

        public final GuardrailStreamConfiguration guardrailConfig()

        Configuration information for a guardrail that you want to use in the request. If you include guardContent blocks in the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent 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 the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent blocks, the guardrail operates on all messages in the request body and in any included prompt resource.

      • additionalModelRequestFields

        public final Document additionalModelRequestFields()

        Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse and ConverseStream support in the inferenceConfig field. For more information, see Model parameters.

        Returns:
        Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse and ConverseStream support in the inferenceConfig 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 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.

      • promptVariables

        public final Map<String,​PromptVariableValues> 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 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. Converse and ConverseStream return 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.

        Converse and ConverseStream reject 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 Converse.

        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 and ConverseStream return 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.

        Converse and ConverseStream reject 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 Converse.

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

      • requestMetadata

        public final Map<String,​String> 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

        public final PerformanceConfiguration performanceConfig()

        Model performance settings for the request.

        Returns:
        Model performance settings for the request.

      • 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