Guides

BEDROCK-AGENT-RUNTIME

Suggest Edits
docs.aws.amazon.com
AWS documentation

DeleteAgentMemory

valid {
    input.ReqMap.agentAliasId == STRING
    input.ReqMap.agentId == STRING
    input.Qs.memoryId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

GetAgentMemory

enum_MemoryType := [ "SESSION_SUMMARY" ]

valid {
    input.ReqMap.agentAliasId == STRING
    input.ReqMap.agentId == STRING
    input.Qs.maxItems == INTEGER
    input.Qs.memoryId == STRING
    input.Qs.memoryType == enum_MemoryType[_]
    input.Qs.nextToken == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

InvokeAgent

enum_ConfirmationState := [ "CONFIRM", "DENY" ]
enum_FileSourceType := [ "S3", "BYTE_CONTENT" ]
enum_FileUseCase := [ "CODE_INTERPRETER", "CHAT" ]
enum_ResponseState := [ "FAILURE", "REPROMPT" ]
enum_SearchType := [ "HYBRID", "SEMANTIC" ]

valid {
    input.Body.enableTrace == BOOLEAN
    input.Body.endSession == BOOLEAN
    input.Body.inputText == STRING
    input.Body.memoryId == STRING
    input.Body.sessionState.files[_].name == STRING
    input.Body.sessionState.files[_].source.byteContent.data == BLOB
    input.Body.sessionState.files[_].source.byteContent.mediaType == STRING
    input.Body.sessionState.files[_].source.s3Location.uri == STRING
    input.Body.sessionState.files[_].source.sourceType == enum_FileSourceType[_]
    input.Body.sessionState.files[_].useCase == enum_FileUseCase[_]
    input.Body.sessionState.invocationId == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].knowledgeBaseId == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.andAll[_] == NESTED
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.equals.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.equals.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.greaterThan.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.greaterThan.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.greaterThanOrEquals.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.greaterThanOrEquals.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.in.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.in.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.lessThan.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.lessThan.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.lessThanOrEquals.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.lessThanOrEquals.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.listContains.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.listContains.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.notEquals.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.notEquals.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.notIn.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.notIn.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.orAll[_] == NESTED
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.startsWith.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.startsWith.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.stringContains.key == STRING
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.filter.stringContains.value == {}
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.numberOfResults == INTEGER
    input.Body.sessionState.knowledgeBaseConfigurations[_].retrievalConfiguration.vectorSearchConfiguration.overrideSearchType == enum_SearchType[_]
    input.Body.sessionState.promptSessionAttributes.STRING == STRING
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.actionGroup == STRING
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.apiPath == STRING
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.confirmationState == enum_ConfirmationState[_]
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.httpMethod == STRING
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.httpStatusCode == INTEGER
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.responseBody.STRING.body == STRING
    input.Body.sessionState.returnControlInvocationResults[_].apiResult.responseState == enum_ResponseState[_]
    input.Body.sessionState.returnControlInvocationResults[_].functionResult.actionGroup == STRING
    input.Body.sessionState.returnControlInvocationResults[_].functionResult.confirmationState == enum_ConfirmationState[_]
    input.Body.sessionState.returnControlInvocationResults[_].functionResult.function == STRING
    input.Body.sessionState.returnControlInvocationResults[_].functionResult.responseBody.STRING.body == STRING
    input.Body.sessionState.returnControlInvocationResults[_].functionResult.responseState == enum_ResponseState[_]
    input.Body.sessionState.sessionAttributes.STRING == STRING
    input.ReqMap.agentAliasId == STRING
    input.ReqMap.agentId == STRING
    input.ReqMap.sessionId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

InvokeFlow

valid {
    input.Body.enableTrace == BOOLEAN
    input.Body.inputs[_].content.document == {}
    input.Body.inputs[_].nodeName == STRING
    input.Body.inputs[_].nodeOutputName == STRING
    input.ReqMap.flowAliasIdentifier == STRING
    input.ReqMap.flowIdentifier == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

OptimizePrompt

valid {
    input.Body.input.textPrompt.text == STRING
    input.Body.targetModelId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

Retrieve

enum_SearchType := [ "HYBRID", "SEMANTIC" ]

valid {
    input.Body.nextToken == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.andAll[_] == NESTED
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.equals.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.equals.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThan.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThan.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThanOrEquals.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThanOrEquals.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.in.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.in.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.lessThan.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.lessThan.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.lessThanOrEquals.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.lessThanOrEquals.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.listContains.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.listContains.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.notEquals.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.notEquals.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.notIn.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.notIn.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.orAll[_] == NESTED
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.startsWith.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.startsWith.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.stringContains.key == STRING
    input.Body.retrievalConfiguration.vectorSearchConfiguration.filter.stringContains.value == {}
    input.Body.retrievalConfiguration.vectorSearchConfiguration.numberOfResults == INTEGER
    input.Body.retrievalConfiguration.vectorSearchConfiguration.overrideSearchType == enum_SearchType[_]
    input.Body.retrievalQuery.text == STRING
    input.ReqMap.knowledgeBaseId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

RetrieveAndGenerate

enum_ExternalSourceType := [ "S3", "BYTE_CONTENT" ]
enum_QueryTransformationType := [ "QUERY_DECOMPOSITION" ]
enum_RetrieveAndGenerateType := [ "KNOWLEDGE_BASE", "EXTERNAL_SOURCES" ]
enum_SearchType := [ "HYBRID", "SEMANTIC" ]

valid {
    input.Body.input.text == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.additionalModelRequestFields.STRING == {}
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.guardrailConfiguration.guardrailId == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.guardrailConfiguration.guardrailVersion == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.maxTokens == INTEGER
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.stopSequences[_] == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.temperature == FLOAT
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.topP == FLOAT
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.generationConfiguration.promptTemplate.textPromptTemplate == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.modelArn == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.sources[_].byteContent.contentType == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.sources[_].byteContent.data == BLOB
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.sources[_].byteContent.identifier == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.sources[_].s3Location.uri == STRING
    input.Body.retrieveAndGenerateConfiguration.externalSourcesConfiguration.sources[_].sourceType == enum_ExternalSourceType[_]
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.additionalModelRequestFields.STRING == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.guardrailConfiguration.guardrailId == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.guardrailConfiguration.guardrailVersion == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.maxTokens == INTEGER
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.stopSequences[_] == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.temperature == FLOAT
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.inferenceConfig.textInferenceConfig.topP == FLOAT
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.generationConfiguration.promptTemplate.textPromptTemplate == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.knowledgeBaseId == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.modelArn == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.additionalModelRequestFields.STRING == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.inferenceConfig.textInferenceConfig.maxTokens == INTEGER
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.inferenceConfig.textInferenceConfig.stopSequences[_] == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.inferenceConfig.textInferenceConfig.temperature == FLOAT
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.inferenceConfig.textInferenceConfig.topP == FLOAT
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.promptTemplate.textPromptTemplate == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.orchestrationConfiguration.queryTransformationConfiguration.type == enum_QueryTransformationType[_]
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.andAll[_] == NESTED
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.equals.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.equals.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThan.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThan.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThanOrEquals.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.greaterThanOrEquals.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.in.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.in.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.lessThan.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.lessThan.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.lessThanOrEquals.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.lessThanOrEquals.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.listContains.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.listContains.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.notEquals.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.notEquals.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.notIn.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.notIn.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.orAll[_] == NESTED
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.startsWith.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.startsWith.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.stringContains.key == STRING
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.filter.stringContains.value == {}
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.numberOfResults == INTEGER
    input.Body.retrieveAndGenerateConfiguration.knowledgeBaseConfiguration.retrievalConfiguration.vectorSearchConfiguration.overrideSearchType == enum_SearchType[_]
    input.Body.retrieveAndGenerateConfiguration.type == enum_RetrieveAndGenerateType[_]
    input.Body.sessionConfiguration.kmsKeyArn == STRING
    input.Body.sessionId == STRING
    input.ProviderMetadata.Account == STRING
    input.ProviderMetadata.AccessKeyId == STRING
    input.ProviderMetadata.Region == STRING
}

Updated about 11 hours ago