KnowledgeBaseRetrieveAndGenerateConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KnowledgeBaseRetrieveAndGenerateConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains details about the resource being queried.

This data type is used in the following API operations:
- Retrieve request – in the knowledgeBaseConfiguration field
- RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KnowledgeBaseRetrieveAndGenerateConfiguration()

Constructors
Constructor and Description
`KnowledgeBaseRetrieveAndGenerateConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KnowledgeBaseRetrieveAndGenerateConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`GenerationConfiguration`	`getGenerationConfiguration()` Contains configurations for response generation based on the knowledge base query results.
`String`	`getKnowledgeBaseId()` The unique identifier of the knowledge base that is queried and the foundation model used for generation.
`String`	`getModelArn()` The ARN of the foundation model used to generate a response.
`OrchestrationConfiguration`	`getOrchestrationConfiguration()` Settings for how the model processes the prompt prior to retrieval and generation.
`KnowledgeBaseRetrievalConfiguration`	`getRetrievalConfiguration()` Contains configurations for how to retrieve and return the knowledge base query.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGenerationConfiguration(GenerationConfiguration generationConfiguration)` Contains configurations for response generation based on the knowledge base query results.
`void`	`setKnowledgeBaseId(String knowledgeBaseId)` The unique identifier of the knowledge base that is queried and the foundation model used for generation.
`void`	`setModelArn(String modelArn)` The ARN of the foundation model used to generate a response.
`void`	`setOrchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)` Settings for how the model processes the prompt prior to retrieval and generation.
`void`	`setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)` Contains configurations for how to retrieve and return the knowledge base query.
`String`	`toString()` Returns a string representation of this object.
`KnowledgeBaseRetrieveAndGenerateConfiguration`	`withGenerationConfiguration(GenerationConfiguration generationConfiguration)` Contains configurations for response generation based on the knowledge base query results.
`KnowledgeBaseRetrieveAndGenerateConfiguration`	`withKnowledgeBaseId(String knowledgeBaseId)` The unique identifier of the knowledge base that is queried and the foundation model used for generation.
`KnowledgeBaseRetrieveAndGenerateConfiguration`	`withModelArn(String modelArn)` The ARN of the foundation model used to generate a response.
`KnowledgeBaseRetrieveAndGenerateConfiguration`	`withOrchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)` Settings for how the model processes the prompt prior to retrieval and generation.
`KnowledgeBaseRetrieveAndGenerateConfiguration`	`withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)` Contains configurations for how to retrieve and return the knowledge base query.

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

- Constructor Detail
  - KnowledgeBaseRetrieveAndGenerateConfiguration
```
public KnowledgeBaseRetrieveAndGenerateConfiguration()
```
- Method Detail
  - setGenerationConfiguration
```
public void setGenerationConfiguration(GenerationConfiguration generationConfiguration)
```
    Contains configurations for response generation based on the knowledge base query results.
    
    Parameters:
    
    generationConfiguration - Contains configurations for response generation based on the knowledge base query results.
  - getGenerationConfiguration
```
public GenerationConfiguration getGenerationConfiguration()
```
    Contains configurations for response generation based on the knowledge base query results.
    
    Returns:
    
    Contains configurations for response generation based on the knowledge base query results.
  - withGenerationConfiguration
```
public KnowledgeBaseRetrieveAndGenerateConfiguration withGenerationConfiguration(GenerationConfiguration generationConfiguration)
```
    Contains configurations for response generation based on the knowledge base query results.
    
    Parameters:
    
    generationConfiguration - Contains configurations for response generation based on the knowledge base query results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKnowledgeBaseId
```
public void setKnowledgeBaseId(String 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.
  - getKnowledgeBaseId
```
public String getKnowledgeBaseId()
```
    The unique identifier of the knowledge base that is queried and the foundation model used for generation.
    
    Returns:
    
    The unique identifier of the knowledge base that is queried and the foundation model used for generation.
  - withKnowledgeBaseId
```
public KnowledgeBaseRetrieveAndGenerateConfiguration withKnowledgeBaseId(String 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.
  - setModelArn
```
public void setModelArn(String 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.
  - getModelArn
```
public String getModelArn()
```
    The ARN of the foundation model used to generate a response.
    
    Returns:
    
    The ARN of the foundation model used to generate a response.
  - withModelArn
```
public KnowledgeBaseRetrieveAndGenerateConfiguration withModelArn(String 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.
  - setOrchestrationConfiguration
```
public void setOrchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)
```
    Settings for how the model processes the prompt prior to retrieval and generation.
    
    Parameters:
    
    orchestrationConfiguration - Settings for how the model processes the prompt prior to retrieval and generation.
  - getOrchestrationConfiguration
```
public OrchestrationConfiguration getOrchestrationConfiguration()
```
    Settings for how the model processes the prompt prior to retrieval and generation.
    
    Returns:
    
    Settings for how the model processes the prompt prior to retrieval and generation.
  - withOrchestrationConfiguration
```
public KnowledgeBaseRetrieveAndGenerateConfiguration withOrchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)
```
    Settings for how the model processes the prompt prior to retrieval and generation.
    
    Parameters:
    
    orchestrationConfiguration - Settings for how the model processes the prompt prior to retrieval and generation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetrievalConfiguration
```
public void setRetrievalConfiguration(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.
  - getRetrievalConfiguration
```
public KnowledgeBaseRetrievalConfiguration getRetrievalConfiguration()
```
    Contains configurations for how to retrieve and return the knowledge base query.
    
    Returns:
    
    Contains configurations for how to retrieve and return the knowledge base query.
  - withRetrievalConfiguration
```
public KnowledgeBaseRetrieveAndGenerateConfiguration withRetrievalConfiguration(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KnowledgeBaseRetrieveAndGenerateConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class KnowledgeBaseRetrieveAndGenerateConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KnowledgeBaseRetrieveAndGenerateConfiguration

Method Detail

setGenerationConfiguration

getGenerationConfiguration

withGenerationConfiguration

setKnowledgeBaseId

getKnowledgeBaseId

withKnowledgeBaseId

setModelArn

getModelArn

withModelArn

setOrchestrationConfiguration

getOrchestrationConfiguration

withOrchestrationConfiguration

setRetrievalConfiguration

getRetrievalConfiguration

withRetrievalConfiguration

toString

equals

hashCode

clone

marshall