Interface KnowledgeBaseFlowNodeConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,
,KnowledgeBaseFlowNodeConfiguration> SdkBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,
,KnowledgeBaseFlowNodeConfiguration> SdkPojo
- Enclosing class:
KnowledgeBaseFlowNodeConfiguration
public static interface KnowledgeBaseFlowNodeConfiguration.Builder
extends SdkPojo, CopyableBuilder<KnowledgeBaseFlowNodeConfiguration.Builder,KnowledgeBaseFlowNodeConfiguration>
-
Method Summary
Modifier and TypeMethodDescriptionguardrailConfiguration
(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.guardrailConfiguration
(GuardrailConfiguration guardrailConfiguration) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.knowledgeBaseId
(String knowledgeBaseId) The unique identifier of the knowledge base to query.The unique identifier of the model or inference profile to use to generate a response from the query results.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
guardrailConfiguration
KnowledgeBaseFlowNodeConfiguration.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
- Parameters:
guardrailConfiguration
- Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
guardrailConfiguration
default KnowledgeBaseFlowNodeConfiguration.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
This is a convenience method that creates an instance of theGuardrailConfiguration.Builder
avoiding the need to create one manually viaGuardrailConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toguardrailConfiguration(GuardrailConfiguration)
.- Parameters:
guardrailConfiguration
- a consumer that will call methods onGuardrailConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
knowledgeBaseId
The unique identifier of the knowledge base to query.
- Parameters:
knowledgeBaseId
- The unique identifier of the knowledge base to query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-