Interface KnowledgeBase.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>
,SdkBuilder<KnowledgeBase.Builder,KnowledgeBase>
,SdkPojo
- Enclosing class:
- KnowledgeBase
public static interface KnowledgeBase.Builder extends SdkPojo, CopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description KnowledgeBase.Builder
description(String description)
The description of the knowledge base associated with the inline agent.KnowledgeBase.Builder
knowledgeBaseId(String knowledgeBaseId)
The unique identifier for a knowledge base associated with the inline agent.default KnowledgeBase.Builder
retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)
The configurations to apply to the knowledge base during query.KnowledgeBase.Builder
retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)
The configurations to apply to the knowledge base during query.-
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 Detail
-
description
KnowledgeBase.Builder description(String description)
The description of the knowledge base associated with the inline agent.
- Parameters:
description
- The description of the knowledge base associated with the inline agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBaseId
KnowledgeBase.Builder knowledgeBaseId(String knowledgeBaseId)
The unique identifier for a knowledge base associated with the inline agent.
- Parameters:
knowledgeBaseId
- The unique identifier for a knowledge base associated with the inline agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrievalConfiguration
KnowledgeBase.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)
The configurations to apply to the knowledge base during query. For more information, see Query configurations.
- Parameters:
retrievalConfiguration
- The configurations to apply to the knowledge base during query. For more information, see Query configurations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrievalConfiguration
default KnowledgeBase.Builder retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)
The configurations to apply to the knowledge base during query. For more information, see Query configurations.
This is a convenience method that creates an instance of theKnowledgeBaseRetrievalConfiguration.Builder
avoiding the need to create one manually viaKnowledgeBaseRetrievalConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretrievalConfiguration(KnowledgeBaseRetrievalConfiguration)
.- Parameters:
retrievalConfiguration
- a consumer that will call methods onKnowledgeBaseRetrievalConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
retrievalConfiguration(KnowledgeBaseRetrievalConfiguration)
-
-