Package software.amazon.awssdk.services.bedrockagent.model

Class PineconeConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.PineconeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PineconeConfiguration.Builder,PineconeConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class PineconeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PineconeConfiguration.Builder,PineconeConfiguration>

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PineconeConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static PineconeConfiguration.Builder	builder()
String	connectionString()	The endpoint URL for your index management page.
String	credentialsSecretArn()	The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PineconeFieldMapping	fieldMapping()	Contains the names of the fields to which to map information about the vector store.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	namespace()	The namespace to be used to write new data to your database.
List<SdkField<?>>	sdkFields()
static Class<? extends PineconeConfiguration.Builder>	serializableBuilderClass()
PineconeConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

connectionString

public final String connectionString()

The endpoint URL for your index management page.

Returns:

The endpoint URL for your index management page.

credentialsSecretArn

public final String credentialsSecretArn()

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

Returns:

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

fieldMapping

public final PineconeFieldMapping fieldMapping()

Contains the names of the fields to which to map information about the vector store.

Returns:

Contains the names of the fields to which to map information about the vector store.

namespace

public final String namespace()

The namespace to be used to write new data to your database.

Returns:

The namespace to be used to write new data to your database.

toBuilder

public PineconeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PineconeConfiguration.Builder,PineconeConfiguration>

builder

public static PineconeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PineconeConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo