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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KnowledgeBaseFlowNodeConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KnowledgeBaseFlowNodeConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GuardrailConfiguration`	`guardrailConfiguration()`	Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
`int`	`hashCode()`
`PromptInferenceConfiguration`	`inferenceConfiguration()`	Contains inference configurations for the prompt.
`String`	`knowledgeBaseId()`	The unique identifier of the knowledge base to query.
`String`	`modelId()`	The unique identifier of the model or inference profile to use to generate a response from the query results.
`Integer`	`numberOfResults()`	The number of results to retrieve from the knowledge base.
`KnowledgeBaseOrchestrationConfiguration`	`orchestrationConfiguration()`	The configuration for orchestrating the retrieval and generation process in the knowledge base node.
`KnowledgeBasePromptTemplate`	`promptTemplate()`	A custom prompt template to use with the knowledge base for generating responses.
`VectorSearchRerankingConfiguration`	`rerankingConfiguration()`	The configuration for reranking the retrieved results from the knowledge base to improve relevance.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KnowledgeBaseFlowNodeConfiguration.Builder>`	`serializableBuilderClass()`
`KnowledgeBaseFlowNodeConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
  - 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.
  - 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.
  - 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.
  - inferenceConfiguration
```
public final PromptInferenceConfiguration inferenceConfiguration()
```
    Contains inference configurations for the prompt.
    
    Returns:
    
    Contains inference configurations for the prompt.
  - 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.
  - 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.
  - toBuilder
```
public KnowledgeBaseFlowNodeConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,KnowledgeBaseFlowNodeConfiguration>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class KnowledgeBaseFlowNodeConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

knowledgeBaseId

modelId

guardrailConfiguration

numberOfResults

promptTemplate

inferenceConfiguration

rerankingConfiguration

orchestrationConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField