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

Interface ConverseRequest.Builder

    • Method Detail

      • modelId

        ConverseRequest.Builder modelId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • messages

        ConverseRequest.Builder messages​(Collection<Message> messages)

        The messages that you want to send to the model.

        Parameters:
        messages - The messages that you want to send to the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messages

        ConverseRequest.Builder messages​(Message... messages)

        The messages that you want to send to the model.

        Parameters:
        messages - The messages that you want to send to the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messages

        ConverseRequest.Builder messages​(Consumer<Message.Builder>... messages)

        The messages that you want to send to the model.

        This is a convenience method that creates an instance of the Message.Builder avoiding the need to create one manually via Message.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #messages(List).

        Parameters:
        messages - a consumer that will call methods on Message.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #messages(java.util.Collection)

      • system

        ConverseRequest.Builder system​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • system

        ConverseRequest.Builder system​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inferenceConfig

        ConverseRequest.Builder inferenceConfig​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • toolConfig

        ConverseRequest.Builder toolConfig​(ToolConfiguration toolConfig)

        Configuration information for the tools that the model can use when generating a response.

        For information about models that support tool use, see Supported models and model features.

        Parameters:
        toolConfig - Configuration information for the tools that the model can use when generating a response.

        For information about models that support tool use, see Supported models and model features.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • guardrailConfig

        ConverseRequest.Builder guardrailConfig​(GuardrailConfiguration 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • additionalModelRequestFields

        ConverseRequest.Builder additionalModelRequestFields​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • promptVariables

        ConverseRequest.Builder promptVariables​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalModelResponseFieldPaths

        ConverseRequest.Builder additionalModelResponseFieldPaths​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalModelResponseFieldPaths

        ConverseRequest.Builder additionalModelResponseFieldPaths​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestMetadata

        ConverseRequest.Builder requestMetadata​(Map<String,​String> requestMetadata)

        Key-value pairs that you can use to filter invocation logs.

        Parameters:
        requestMetadata - Key-value pairs that you can use to filter invocation logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performanceConfig

        ConverseRequest.Builder performanceConfig​(PerformanceConfiguration performanceConfig)

        Model performance settings for the request.

        Parameters:
        performanceConfig - Model performance settings for the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.