Package software.amazon.awssdk.services.bedrockagentruntime.model

Class RetrieveAndGenerateResponse

    • Method Detail

      • hasCitations

        public final boolean hasCitations()
        For responses, this returns true if the service returned a value for the Citations 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.

      • citations

        public final List<Citation> citations()

        A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

        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 hasCitations() method.

        Returns:
        A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

      • guardrailAction

        public final GuadrailAction guardrailAction()

        Specifies if there is a guardrail intervention in the response.

        If the service returns an enum value that is not available in the current SDK version, guardrailAction will return GuadrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from guardrailActionAsString().

        Returns:
        Specifies if there is a guardrail intervention in the response.
        See Also:
        GuadrailAction

      • guardrailActionAsString

        public final String guardrailActionAsString()

        Specifies if there is a guardrail intervention in the response.

        If the service returns an enum value that is not available in the current SDK version, guardrailAction will return GuadrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from guardrailActionAsString().

        Returns:
        Specifies if there is a guardrail intervention in the response.
        See Also:
        GuadrailAction

      • output

        public final RetrieveAndGenerateOutput output()

        Contains the response generated from querying the knowledge base.

        Returns:
        Contains the response generated from querying the knowledge base.

      • sessionId

        public final String sessionId()

        The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

        Returns:
        The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

      • 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