Class ParsingConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.ParsingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParsingConfiguration.Builder,ParsingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ParsingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParsingConfiguration.Builder,ParsingConfiguration>

Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the parsingStrategy field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see Parsing options for your data source.

If you specify BEDROCK_DATA_AUTOMATION or BEDROCK_FOUNDATION_MODEL and it fails to parse a file, the Amazon Bedrock default parser will be used instead.

See Also:

  • Method Details

    • bedrockDataAutomationConfiguration

      public final BedrockDataAutomationConfiguration bedrockDataAutomationConfiguration()

      If you specify BEDROCK_DATA_AUTOMATION as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser.

      Returns:
      If you specify BEDROCK_DATA_AUTOMATION as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser.

    • bedrockFoundationModelConfiguration

      public final BedrockFoundationModelConfiguration bedrockFoundationModelConfiguration()

      If you specify BEDROCK_FOUNDATION_MODEL as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents.

      Returns:
      If you specify BEDROCK_FOUNDATION_MODEL as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents.

    • parsingStrategy

      public final ParsingStrategy parsingStrategy()

      The parsing strategy for the data source.

      If the service returns an enum value that is not available in the current SDK version, parsingStrategy will return ParsingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parsingStrategyAsString().

      Returns:
      The parsing strategy for the data source.
      See Also:

    • parsingStrategyAsString

      public final String parsingStrategyAsString()

      The parsing strategy for the data source.

      If the service returns an enum value that is not available in the current SDK version, parsingStrategy will return ParsingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parsingStrategyAsString().

      Returns:
      The parsing strategy for the data source.
      See Also:

    • toBuilder

      public ParsingConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParsingConfiguration.Builder,ParsingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ParsingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParsingConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.