bedrockagentruntime/aws.sdk.kotlin.services.bedrockagentruntime.model/RetrieveRequest/Builder

Builder

class Builder

Properties

guardrailConfiguration

var guardrailConfiguration: GuardrailConfiguration?

Guardrail settings.

knowledgeBaseId

var knowledgeBaseId: String?

The unique identifier of the knowledge base to query.

nextToken

var nextToken: String?

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

retrievalConfiguration

var retrievalConfiguration: KnowledgeBaseRetrievalConfiguration?

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

retrievalQuery

var retrievalQuery: KnowledgeBaseQuery?

Contains the query to send the knowledge base.

userContext

var userContext: UserContext?

Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.

Functions

guardrailConfiguration

fun guardrailConfiguration(block: GuardrailConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentruntime.model.GuardrailConfiguration inside the given block

retrievalConfiguration

fun retrievalConfiguration(block: KnowledgeBaseRetrievalConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration inside the given block

retrievalQuery

fun retrievalQuery(block: KnowledgeBaseQuery.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentruntime.model.KnowledgeBaseQuery inside the given block

userContext

fun userContext(block: UserContext.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.bedrockagentruntime.model.UserContext inside the given block