data class AgentInferenceConfiguration(val maximumLength: Double? = null, val stopSequences: List<String>? = null, val temperature: Double? = null, val topK: Double? = null, val topP: Double? = null)

Configuration for inference in prompt configuration

AgentKnowledgeBase

data class AgentKnowledgeBase(val description: String, val knowledgeBaseId: String, val knowledgeBaseState: AgentKnowledgeBaseState? = null)

Agent Knowledge Base

AgentParameterDetail

data class AgentParameterDetail(val description: String? = null, val required: Boolean? = null, val type: AgentType)

Parameter detail

AgentPromptConfiguration

data class AgentPromptConfiguration(val basePromptTemplate: String? = null, val inferenceConfiguration: AgentInferenceConfiguration? = null, val parserMode: AgentCreationMode? = null, val promptCreationMode: AgentCreationMode? = null, val promptState: AgentPromptState? = null, val promptType: AgentPromptType? = null)

BasePromptConfiguration per Prompt Type.

AgentPromptOverrideConfiguration

data class AgentPromptOverrideConfiguration(val overrideLambda: String? = null, val promptConfigurations: List<AgentPromptConfiguration>)

Configuration for prompt override.

AgentS3Identifier

data class AgentS3Identifier(val s3BucketName: String? = null, val s3ObjectKey: String? = null)

The identifier for the S3 resource.

DataSourceChunkingConfiguration

data class DataSourceChunkingConfiguration(val chunkingStrategy: DataSourceChunkingStrategy, val fixedSizeChunkingConfiguration: DataSourceFixedSizeChunkingConfiguration? = null)

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

DataSourceConfiguration

data class DataSourceConfiguration(val s3Configuration: DataSourceS3DataSourceConfiguration, val type: DataSourceType)

Specifies a raw data source location to ingest.

DataSourceFixedSizeChunkingConfiguration

data class DataSourceFixedSizeChunkingConfiguration(val maxTokens: Int, val overlapPercentage: Int)

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

DataSourceS3DataSourceConfiguration

data class DataSourceS3DataSourceConfiguration(val bucketArn: String, val bucketOwnerAccountId: String? = null, val inclusionPrefixes: List<String>? = null)

Contains information about the S3 configuration of the data source.

DataSourceServerSideEncryptionConfiguration

data class DataSourceServerSideEncryptionConfiguration(val kmsKeyArn: String? = null)

Contains details about the server-side encryption for the data source.

DataSourceVectorIngestionConfiguration

data class DataSourceVectorIngestionConfiguration(val chunkingConfiguration: DataSourceChunkingConfiguration? = null)

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

GetAgentAliasResult

data class GetAgentAliasResult(val agentAliasArn: String? = null, val agentAliasHistoryEvents: List<AgentAliasHistoryEvent>? = null, val agentAliasId: String? = null, val agentAliasName: String? = null, val agentAliasStatus: AgentAliasStatus? = null, val createdAt: String? = null, val description: String? = null, val routingConfiguration: List<AgentAliasRoutingConfigurationListItem>? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)

GetAgentResult

data class GetAgentResult(val actionGroups: List<AgentActionGroup>? = null, val agentArn: String? = null, val agentId: String? = null, val agentName: String? = null, val agentResourceRoleArn: String? = null, val agentStatus: AgentStatus? = null, val agentVersion: String? = null, val createdAt: String? = null, val customerEncryptionKeyArn: String? = null, val description: String? = null, val failureReasons: List<String>? = null, val foundationModel: String? = null, val idleSessionTtlInSeconds: Double? = null, val instruction: String? = null, val knowledgeBases: List<AgentKnowledgeBase>? = null, val preparedAt: String? = null, val promptOverrideConfiguration: AgentPromptOverrideConfiguration? = null, val recommendedActions: List<String>? = null, val tags: Map<String, String>? = null, val testAliasTags: Map<String, String>? = null, val updatedAt: String? = null)

GetDataSourceResult

data class GetDataSourceResult(val createdAt: String? = null, val dataDeletionPolicy: DataSourceDataDeletionPolicy? = null, val dataSourceConfiguration: DataSourceConfiguration? = null, val dataSourceId: String? = null, val dataSourceStatus: DataSourceStatus? = null, val description: String? = null, val failureReasons: List<String>? = null, val name: String? = null, val serverSideEncryptionConfiguration: DataSourceServerSideEncryptionConfiguration? = null, val updatedAt: String? = null)

GetGuardrailResult

data class GetGuardrailResult(val blockedInputMessaging: String? = null, val blockedOutputsMessaging: String? = null, val contentPolicyConfig: GuardrailContentPolicyConfig? = null, val createdAt: String? = null, val description: String? = null, val failureRecommendations: List<String>? = null, val guardrailArn: String? = null, val guardrailId: String? = null, val kmsKeyArn: String? = null, val name: String? = null, val sensitiveInformationPolicyConfig: GuardrailSensitiveInformationPolicyConfig? = null, val status: GuardrailStatus? = null, val statusReasons: List<String>? = null, val tags: List<Tag>? = null, val topicPolicyConfig: GuardrailTopicPolicyConfig? = null, val updatedAt: String? = null, val version: String? = null, val wordPolicyConfig: GuardrailWordPolicyConfig? = null)

GetGuardrailVersionResult

data class GetGuardrailVersionResult(val guardrailArn: String? = null, val guardrailId: String? = null, val version: String? = null)

GetKnowledgeBaseResult

data class GetKnowledgeBaseResult(val createdAt: String? = null, val description: String? = null, val failureReasons: List<String>? = null, val knowledgeBaseArn: String? = null, val knowledgeBaseId: String? = null, val name: String? = null, val roleArn: String? = null, val status: KnowledgeBaseStatus? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)

GuardrailContentFilterConfig

data class GuardrailContentFilterConfig(val inputStrength: GuardrailFilterStrength, val outputStrength: GuardrailFilterStrength, val type: GuardrailContentFilterType)

Content filter config in content policy.

GuardrailContentPolicyConfig

data class GuardrailContentPolicyConfig(val filtersConfig: List<GuardrailContentFilterConfig>)

Content policy config for a guardrail.

GuardrailManagedWordsConfig

data class GuardrailManagedWordsConfig(val type: GuardrailManagedWordsType)

A managed words config.

GuardrailPiiEntityConfig

data class GuardrailPiiEntityConfig(val action: GuardrailSensitiveInformationAction, val type: GuardrailPiiEntityType)

Pii entity configuration.

GuardrailRegexConfig

data class GuardrailRegexConfig(val action: GuardrailSensitiveInformationAction, val description: String? = null, val name: String, val pattern: String)

A regex configuration.

GuardrailSensitiveInformationPolicyConfig

data class GuardrailSensitiveInformationPolicyConfig(val piiEntitiesConfig: List<GuardrailPiiEntityConfig>? = null, val regexesConfig: List<GuardrailRegexConfig>? = null)

Sensitive information policy config for a guardrail.

GuardrailTopicConfig

data class GuardrailTopicConfig(val definition: String, val examples: List<String>? = null, val name: String, val type: GuardrailTopicType)

Topic config in topic policy.

GuardrailTopicPolicyConfig

data class GuardrailTopicPolicyConfig(val topicsConfig: List<GuardrailTopicConfig>)

Topic policy config for a guardrail.

GuardrailWordConfig

data class GuardrailWordConfig(val text: String)

A custom word config.

GuardrailWordPolicyConfig

data class GuardrailWordPolicyConfig(val managedWordListsConfig: List<GuardrailManagedWordsConfig>? = null, val wordsConfig: List<GuardrailWordConfig>? = null)

Word policy config for a guardrail.

KnowledgeBaseConfiguration

data class KnowledgeBaseConfiguration(val type: KnowledgeBaseType, val vectorKnowledgeBaseConfiguration: KnowledgeBaseVectorKnowledgeBaseConfiguration)

Contains details about the embeddings model used for the knowledge base.

KnowledgeBaseOpenSearchServerlessConfiguration

data class KnowledgeBaseOpenSearchServerlessConfiguration(val collectionArn: String, val fieldMapping: KnowledgeBaseOpenSearchServerlessFieldMapping, val vectorIndexName: String)

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

KnowledgeBaseOpenSearchServerlessFieldMapping

data class KnowledgeBaseOpenSearchServerlessFieldMapping(val metadataField: String, val textField: String, val vectorField: String)

A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names

KnowledgeBasePineconeConfiguration

data class KnowledgeBasePineconeConfiguration(val connectionString: String, val credentialsSecretArn: String, val fieldMapping: KnowledgeBasePineconeFieldMapping, val namespace: String? = null)

Contains the storage configuration of the knowledge base in Pinecone.

KnowledgeBasePineconeFieldMapping

data class KnowledgeBasePineconeFieldMapping(val metadataField: String, val textField: String)

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

KnowledgeBaseRdsConfiguration

data class KnowledgeBaseRdsConfiguration(val credentialsSecretArn: String, val databaseName: String, val fieldMapping: KnowledgeBaseRdsFieldMapping, val resourceArn: String, val tableName: String)

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

KnowledgeBaseRdsFieldMapping

data class KnowledgeBaseRdsFieldMapping(val metadataField: String, val primaryKeyField: String, val textField: String, val vectorField: String)

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

KnowledgeBaseStorageConfiguration

data class KnowledgeBaseStorageConfiguration(val opensearchServerlessConfiguration: KnowledgeBaseOpenSearchServerlessConfiguration? = null, val pineconeConfiguration: KnowledgeBasePineconeConfiguration? = null, val rdsConfiguration: KnowledgeBaseRdsConfiguration? = null, val type: KnowledgeBaseStorageType)

The vector store service in which the knowledge base is stored.

KnowledgeBaseVectorKnowledgeBaseConfiguration

data class KnowledgeBaseVectorKnowledgeBaseConfiguration(val embeddingModelArn: String)

Contains details about the model used to create vector embeddings for the knowledge base.