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

Class ConverseRequest

    • Method Detail

      • modelId

        public final String modelId()

        The identifier for the model that you want to call.

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

        Returns:
        The identifier for the model that you want to call.

        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 pass 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 pass to the model.

      • inferenceConfig

        public final InferenceConfiguration inferenceConfig()

        Inference parameters to pass to the model. Converse 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. Converse 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, Cohere Command R, Cohere Command R+, and Mistral Large 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, Cohere Command R, Cohere Command R+, and Mistral Large models.

      • guardrailConfig

        public final GuardrailConfiguration 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 Converse supports 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 supports in the inferenceConfig field. For more information, see Model parameters.

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

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

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

      • 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