com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.bedrockagentruntime.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RetrieveAndGenerateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Contains the query to be made to the knowledge base.
*
*/
private RetrieveAndGenerateInput input;
/**
*
* Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
*
*/
private RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration;
/**
*
* Contains details about the session with the knowledge base.
*
*/
private RetrieveAndGenerateSessionConfiguration sessionConfiguration;
/**
*
* The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon
* Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same
* conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous
* interactions. You can't explicitly set the sessionId yourself.
*
*/
private String sessionId;
/**
*
* Contains the query to be made to the knowledge base.
*
*
* @param input
* Contains the query to be made to the knowledge base.
*/
public void setInput(RetrieveAndGenerateInput input) {
this.input = input;
}
/**
*
* Contains the query to be made to the knowledge base.
*
*
* @return Contains the query to be made to the knowledge base.
*/
public RetrieveAndGenerateInput getInput() {
return this.input;
}
/**
*
* Contains the query to be made to the knowledge base.
*
*
* @param input
* Contains the query to be made to the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetrieveAndGenerateRequest withInput(RetrieveAndGenerateInput input) {
setInput(input);
return this;
}
/**
*
* Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
*
*
* @param retrieveAndGenerateConfiguration
* Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
*/
public void setRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration) {
this.retrieveAndGenerateConfiguration = retrieveAndGenerateConfiguration;
}
/**
*
* Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
*
*
* @return Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
*/
public RetrieveAndGenerateConfiguration getRetrieveAndGenerateConfiguration() {
return this.retrieveAndGenerateConfiguration;
}
/**
*
* Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
*
*
* @param retrieveAndGenerateConfiguration
* Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetrieveAndGenerateRequest withRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration) {
setRetrieveAndGenerateConfiguration(retrieveAndGenerateConfiguration);
return this;
}
/**
*
* Contains details about the session with the knowledge base.
*
*
* @param sessionConfiguration
* Contains details about the session with the knowledge base.
*/
public void setSessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration) {
this.sessionConfiguration = sessionConfiguration;
}
/**
*
* Contains details about the session with the knowledge base.
*
*
* @return Contains details about the session with the knowledge base.
*/
public RetrieveAndGenerateSessionConfiguration getSessionConfiguration() {
return this.sessionConfiguration;
}
/**
*
* Contains details about the session with the knowledge base.
*
*
* @param sessionConfiguration
* Contains details about the session with the knowledge base.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetrieveAndGenerateRequest withSessionConfiguration(RetrieveAndGenerateSessionConfiguration sessionConfiguration) {
setSessionConfiguration(sessionConfiguration);
return this;
}
/**
*
* The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon
* Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same
* conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous
* interactions. You can't explicitly set the sessionId yourself.
*
*
* @param sessionId
* The unique identifier of the session. When you first make a RetrieveAndGenerate request,
* Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests
* in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge
* from previous interactions. You can't explicitly set the sessionId yourself.
*/
public void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
/**
*
* The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon
* Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same
* conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous
* interactions. You can't explicitly set the sessionId yourself.
*
*
* @return The unique identifier of the session. When you first make a RetrieveAndGenerate request,
* Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests
* in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge
* from previous interactions. You can't explicitly set the sessionId yourself.
*/
public String getSessionId() {
return this.sessionId;
}
/**
*
* The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon
* Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same
* conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous
* interactions. You can't explicitly set the sessionId yourself.
*
*
* @param sessionId
* The unique identifier of the session. When you first make a RetrieveAndGenerate request,
* Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests
* in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge
* from previous interactions. You can't explicitly set the sessionId yourself.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetrieveAndGenerateRequest withSessionId(String sessionId) {
setSessionId(sessionId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInput() != null)
sb.append("Input: ").append("***Sensitive Data Redacted***").append(",");
if (getRetrieveAndGenerateConfiguration() != null)
sb.append("RetrieveAndGenerateConfiguration: ").append(getRetrieveAndGenerateConfiguration()).append(",");
if (getSessionConfiguration() != null)
sb.append("SessionConfiguration: ").append(getSessionConfiguration()).append(",");
if (getSessionId() != null)
sb.append("SessionId: ").append(getSessionId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RetrieveAndGenerateRequest == false)
return false;
RetrieveAndGenerateRequest other = (RetrieveAndGenerateRequest) obj;
if (other.getInput() == null ^ this.getInput() == null)
return false;
if (other.getInput() != null && other.getInput().equals(this.getInput()) == false)
return false;
if (other.getRetrieveAndGenerateConfiguration() == null ^ this.getRetrieveAndGenerateConfiguration() == null)
return false;
if (other.getRetrieveAndGenerateConfiguration() != null
&& other.getRetrieveAndGenerateConfiguration().equals(this.getRetrieveAndGenerateConfiguration()) == false)
return false;
if (other.getSessionConfiguration() == null ^ this.getSessionConfiguration() == null)
return false;
if (other.getSessionConfiguration() != null && other.getSessionConfiguration().equals(this.getSessionConfiguration()) == false)
return false;
if (other.getSessionId() == null ^ this.getSessionId() == null)
return false;
if (other.getSessionId() != null && other.getSessionId().equals(this.getSessionId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInput() == null) ? 0 : getInput().hashCode());
hashCode = prime * hashCode + ((getRetrieveAndGenerateConfiguration() == null) ? 0 : getRetrieveAndGenerateConfiguration().hashCode());
hashCode = prime * hashCode + ((getSessionConfiguration() == null) ? 0 : getSessionConfiguration().hashCode());
hashCode = prime * hashCode + ((getSessionId() == null) ? 0 : getSessionId().hashCode());
return hashCode;
}
@Override
public RetrieveAndGenerateRequest clone() {
return (RetrieveAndGenerateRequest) super.clone();
}
}