Package software.amazon.awscdk.services.bedrock

Interface CfnDataSource.BedrockFoundationModelConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.BedrockFoundationModelConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.BedrockFoundationModelConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Settings for a foundation model or inference profile used to parse documents for a data source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 BedrockFoundationModelConfigurationProperty bedrockFoundationModelConfigurationProperty = BedrockFoundationModelConfigurationProperty.builder()
         .modelArn("modelArn")
         // the properties below are optional
         .parsingModality("parsingModality")
         .parsingPrompt(ParsingPromptProperty.builder()
                 .parsingPromptText("parsingPromptText")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.BedrockFoundationModelConfigurationProperty.Builder	A builder for CfnDataSource.BedrockFoundationModelConfigurationProperty
static final class	CfnDataSource.BedrockFoundationModelConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.BedrockFoundationModelConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.BedrockFoundationModelConfigurationProperty.Builder	builder()
String	getModelArn()	The ARN of the foundation model or inference profile to use for parsing.
default String	getParsingModality()	Specifies whether to enable parsing of multimodal data, including both text and/or images.
default Object	getParsingPrompt()	Instructions for interpreting the contents of a document.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getModelArn

@Stability(Stable)
@NotNull
String getModelArn()

The ARN of the foundation model or inference profile to use for parsing.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-modelarn

getParsingModality

@Stability(Stable)
@Nullable
default String getParsingModality()

Specifies whether to enable parsing of multimodal data, including both text and/or images.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingmodality

getParsingPrompt

@Stability(Stable)
@Nullable
default Object getParsingPrompt()

Instructions for interpreting the contents of a document.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.html#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingprompt

builder

@Stability(Stable)
static CfnDataSource.BedrockFoundationModelConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.BedrockFoundationModelConfigurationProperty.Builder of CfnDataSource.BedrockFoundationModelConfigurationProperty