Interface KnowledgeBaseRetrieveAndGenerateConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<KnowledgeBaseRetrieveAndGenerateConfiguration.Builder,
,KnowledgeBaseRetrieveAndGenerateConfiguration> SdkBuilder<KnowledgeBaseRetrieveAndGenerateConfiguration.Builder,
,KnowledgeBaseRetrieveAndGenerateConfiguration> SdkPojo
- Enclosing class:
KnowledgeBaseRetrieveAndGenerateConfiguration
-
Method Summary
Modifier and TypeMethodDescriptiongenerationConfiguration
(Consumer<GenerationConfiguration.Builder> generationConfiguration) Contains configurations for response generation based on the knowwledge base query results.generationConfiguration
(GenerationConfiguration generationConfiguration) Contains configurations for response generation based on the knowwledge base query results.knowledgeBaseId
(String knowledgeBaseId) The unique identifier of the knowledge base that is queried and the foundation model used for generation.The ARN of the foundation model used to generate a response.retrievalConfiguration
(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration) Contains configurations for how to retrieve and return the knowledge base query.retrievalConfiguration
(KnowledgeBaseRetrievalConfiguration retrievalConfiguration) Contains configurations for how to retrieve and return the knowledge base 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, sdkFields
-
Method Details
-
generationConfiguration
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder generationConfiguration(GenerationConfiguration generationConfiguration) Contains configurations for response generation based on the knowwledge base query results.
- Parameters:
generationConfiguration
- Contains configurations for response generation based on the knowwledge base query results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
generationConfiguration
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder generationConfiguration(Consumer<GenerationConfiguration.Builder> generationConfiguration) Contains configurations for response generation based on the knowwledge base query results.
This is a convenience method that creates an instance of theGenerationConfiguration.Builder
avoiding the need to create one manually viaGenerationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togenerationConfiguration(GenerationConfiguration)
.- Parameters:
generationConfiguration
- a consumer that will call methods onGenerationConfiguration.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 that is queried and the foundation model used for generation.
- Parameters:
knowledgeBaseId
- The unique identifier of the knowledge base that is queried and the foundation model used for generation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelArn
The ARN of the foundation model used to generate a response.
- Parameters:
modelArn
- The ARN of the foundation model used to generate a response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrievalConfiguration
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration) Contains configurations for how to retrieve and return the knowledge base query.
- Parameters:
retrievalConfiguration
- Contains configurations for how to retrieve and return the knowledge base query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrievalConfiguration
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration) Contains configurations for how to retrieve and return the knowledge base query.
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:
-