com.amazonaws.services.bedrockagent.model

Class OpenSearchServerlessFieldMapping

java.lang.Object

com.amazonaws.services.bedrockagent.model.OpenSearchServerlessFieldMapping

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OpenSearchServerlessFieldMapping
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OpenSearchServerlessFieldMapping()

Method Summary

Modifier and Type	Method and Description
OpenSearchServerlessFieldMapping	clone()
boolean	equals(Object obj)
String	getMetadataField() The name of the field in which Amazon Bedrock stores metadata about the vector store.
String	getTextField() The name of the field in which Amazon Bedrock stores the raw text from your data.
String	getVectorField() The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMetadataField(String metadataField) The name of the field in which Amazon Bedrock stores metadata about the vector store.
void	setTextField(String textField) The name of the field in which Amazon Bedrock stores the raw text from your data.
void	setVectorField(String vectorField) The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
String	toString() Returns a string representation of this object.
OpenSearchServerlessFieldMapping	withMetadataField(String metadataField) The name of the field in which Amazon Bedrock stores metadata about the vector store.
OpenSearchServerlessFieldMapping	withTextField(String textField) The name of the field in which Amazon Bedrock stores the raw text from your data.
OpenSearchServerlessFieldMapping	withVectorField(String vectorField) The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenSearchServerlessFieldMapping

public OpenSearchServerlessFieldMapping()

Method Detail

setMetadataField

public void setMetadataField(String metadataField)

The name of the field in which Amazon Bedrock stores metadata about the vector store.

Parameters:

metadataField - The name of the field in which Amazon Bedrock stores metadata about the vector store.

getMetadataField

public String getMetadataField()

The name of the field in which Amazon Bedrock stores metadata about the vector store.

Returns:

The name of the field in which Amazon Bedrock stores metadata about the vector store.

withMetadataField

public OpenSearchServerlessFieldMapping withMetadataField(String metadataField)

The name of the field in which Amazon Bedrock stores metadata about the vector store.

Parameters:

metadataField - The name of the field in which Amazon Bedrock stores metadata about the vector store.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTextField

public void setTextField(String textField)

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

Parameters:

textField - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

getTextField

public String getTextField()

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

Returns:

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

withTextField

public OpenSearchServerlessFieldMapping withTextField(String textField)

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

Parameters:

textField - The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVectorField

public void setVectorField(String vectorField)

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

Parameters:

vectorField - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

getVectorField

public String getVectorField()

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

Returns:

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

withVectorField

public OpenSearchServerlessFieldMapping withVectorField(String vectorField)

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

Parameters:

vectorField - The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

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 OpenSearchServerlessFieldMapping 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.