Class KnowledgeBaseFlowNodeConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.KnowledgeBaseFlowNodeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,KnowledgeBaseFlowNodeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class KnowledgeBaseFlowNodeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,KnowledgeBaseFlowNodeConfiguration>

Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.

See Also:

  • Method Details

    • guardrailConfiguration

      public final GuardrailConfiguration guardrailConfiguration()

      Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

      Returns:
      Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

    • inferenceConfiguration

      public final PromptInferenceConfiguration inferenceConfiguration()

      Contains inference configurations for the prompt.

      Returns:
      Contains inference configurations for the prompt.

    • knowledgeBaseId

      public final String knowledgeBaseId()

      The unique identifier of the knowledge base to query.

      Returns:
      The unique identifier of the knowledge base to query.

    • modelId

      public final String modelId()

      The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

      Returns:
      The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

    • numberOfResults

      public final Integer numberOfResults()

      The number of results to retrieve from the knowledge base.

      Returns:
      The number of results to retrieve from the knowledge base.

    • orchestrationConfiguration

      public final KnowledgeBaseOrchestrationConfiguration orchestrationConfiguration()

      The configuration for orchestrating the retrieval and generation process in the knowledge base node.

      Returns:
      The configuration for orchestrating the retrieval and generation process in the knowledge base node.

    • promptTemplate

      public final KnowledgeBasePromptTemplate promptTemplate()

      A custom prompt template to use with the knowledge base for generating responses.

      Returns:
      A custom prompt template to use with the knowledge base for generating responses.

    • rerankingConfiguration

      public final VectorSearchRerankingConfiguration rerankingConfiguration()

      The configuration for reranking the retrieved results from the knowledge base to improve relevance.

      Returns:
      The configuration for reranking the retrieved results from the knowledge base to improve relevance.

    • toBuilder

      public KnowledgeBaseFlowNodeConfiguration.Builder 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 interface ToCopyableBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,KnowledgeBaseFlowNodeConfiguration>
      Returns:
      a builder for type T

    • builder

      public static KnowledgeBaseFlowNodeConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KnowledgeBaseFlowNodeConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.