com.amazonaws.services.bedrockagent.model.VectorKnowledgeBaseConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-bedrockagent Show documentation
The AWS Java SDK for Agents for Amazon Bedrock module holds the client classes that are used for communicating with Agents for Amazon Bedrock Service
The newest version!
/*
 * 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.bedrockagent.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * Contains details about the model used to create vector embeddings for the knowledge base.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class VectorKnowledgeBaseConfiguration implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     * 
     */
    private String embeddingModelArn;
    /**
     * 
     * The embeddings model configuration details for the vector model used in Knowledge Base.
     * 
     */
    private EmbeddingModelConfiguration embeddingModelConfiguration;

    /**
     * 
     * The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     * 
     * 
     * @param embeddingModelArn
     *        The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     */

    public void setEmbeddingModelArn(String embeddingModelArn) {
        this.embeddingModelArn = embeddingModelArn;
    }

    /**
     * 
     * The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     * 
     * 
     * @return The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     */

    public String getEmbeddingModelArn() {
        return this.embeddingModelArn;
    }

    /**
     * 
     * The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     * 
     * 
     * @param embeddingModelArn
     *        The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public VectorKnowledgeBaseConfiguration withEmbeddingModelArn(String embeddingModelArn) {
        setEmbeddingModelArn(embeddingModelArn);
        return this;
    }

    /**
     * 
     * The embeddings model configuration details for the vector model used in Knowledge Base.
     * 
     * 
     * @param embeddingModelConfiguration
     *        The embeddings model configuration details for the vector model used in Knowledge Base.
     */

    public void setEmbeddingModelConfiguration(EmbeddingModelConfiguration embeddingModelConfiguration) {
        this.embeddingModelConfiguration = embeddingModelConfiguration;
    }

    /**
     * 
     * The embeddings model configuration details for the vector model used in Knowledge Base.
     * 
     * 
     * @return The embeddings model configuration details for the vector model used in Knowledge Base.
     */

    public EmbeddingModelConfiguration getEmbeddingModelConfiguration() {
        return this.embeddingModelConfiguration;
    }

    /**
     * 
     * The embeddings model configuration details for the vector model used in Knowledge Base.
     * 
     * 
     * @param embeddingModelConfiguration
     *        The embeddings model configuration details for the vector model used in Knowledge Base.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public VectorKnowledgeBaseConfiguration withEmbeddingModelConfiguration(EmbeddingModelConfiguration embeddingModelConfiguration) {
        setEmbeddingModelConfiguration(embeddingModelConfiguration);
        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 (getEmbeddingModelArn() != null)
            sb.append("EmbeddingModelArn: ").append(getEmbeddingModelArn()).append(",");
        if (getEmbeddingModelConfiguration() != null)
            sb.append("EmbeddingModelConfiguration: ").append(getEmbeddingModelConfiguration());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof VectorKnowledgeBaseConfiguration == false)
            return false;
        VectorKnowledgeBaseConfiguration other = (VectorKnowledgeBaseConfiguration) obj;
        if (other.getEmbeddingModelArn() == null ^ this.getEmbeddingModelArn() == null)
            return false;
        if (other.getEmbeddingModelArn() != null && other.getEmbeddingModelArn().equals(this.getEmbeddingModelArn()) == false)
            return false;
        if (other.getEmbeddingModelConfiguration() == null ^ this.getEmbeddingModelConfiguration() == null)
            return false;
        if (other.getEmbeddingModelConfiguration() != null && other.getEmbeddingModelConfiguration().equals(this.getEmbeddingModelConfiguration()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getEmbeddingModelArn() == null) ? 0 : getEmbeddingModelArn().hashCode());
        hashCode = prime * hashCode + ((getEmbeddingModelConfiguration() == null) ? 0 : getEmbeddingModelConfiguration().hashCode());
        return hashCode;
    }

    @Override
    public VectorKnowledgeBaseConfiguration clone() {
        try {
            return (VectorKnowledgeBaseConfiguration) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.bedrockagent.model.transform.VectorKnowledgeBaseConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}